org.bytedeco.tvm

Class ObjectPtr

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tvm.ObjectPtr

All Implemented Interfaces:

AutoCloseable

@Name(value="tvm::runtime::ObjectPtr<tvm::runtime::Object>")
 @NoOffset
 @Properties(inherit=tvm_runtime.class)
public class ObjectPtr
extends Pointer

\brief A custom smart pointer for Object. \tparam T the content data type.

See Also:

make_object

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
ObjectPtr() \brief default constructor
ObjectPtr(long size) Native array allocator.
ObjectPtr(ObjectPtr other) \brief copy constructor
ObjectPtr(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
TVMObject	access()
boolean	asBoolean() \brief nullptr check
boolean	equals(ObjectPtr other)
TVMObject	get()
ObjectPtr	getPointer(long i)
TVMObject	multiply()
boolean	notEquals(ObjectPtr other)
ObjectPtr	position(long position)
ObjectPtr	put(ObjectPtr other) \brief copy assignment
void	reset() \brief reset the content of ptr to be nullptr
void	swap(ObjectPtr other) \brief Swap this array with another Object
boolean	unique()
int	use_count()

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectPtr

public ObjectPtr(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

ObjectPtr

public ObjectPtr(long size)

Native array allocator. Access with Pointer.position(long).

ObjectPtr

public ObjectPtr()

\brief default constructor

ObjectPtr

public ObjectPtr(@Const @ByRef
                 ObjectPtr other)

\brief copy constructor

Parameters:

other - The value to be moved

Method Detail

position

public ObjectPtr position(long position)

Overrides:

position in class Pointer

getPointer

public ObjectPtr getPointer(long i)

Overrides:

getPointer in class Pointer

swap

public void swap(@ByRef
                 ObjectPtr other)

\brief Swap this array with another Object

Parameters:

other - The other Object

get

public TVMObject get()

Returns:

Get the content of the pointer

access

@Name(value="operator ->")
public TVMObject access()

Returns:

The pointer

multiply

@ByRef
 @Name(value="operator *")
public TVMObject multiply()

Returns:

The reference

put

@ByRef
 @Name(value="operator =")
public ObjectPtr put(@Const @ByRef
                                                         ObjectPtr other)

\brief copy assignment

Parameters:

other - The value to be assigned.

Returns:

reference to self.

asBoolean

@Cast(value="bool")
 @Name(value="operator bool")
public boolean asBoolean()

\brief nullptr check

Returns:

result of comparison of internal pointer with nullptr.

reset

public void reset()

\brief reset the content of ptr to be nullptr

use_count

public int use_count()

Returns:

The use count of the ptr, for debug purposes

unique

@Cast(value="bool")
public boolean unique()

Returns:

whether the reference is unique

equals

@Cast(value="bool")
 @Name(value="operator ==")
public boolean equals(@Const @ByRef
                                                                        ObjectPtr other)

Returns:

Whether two ObjectPtr do not equal each other

notEquals

@Cast(value="bool")
 @Name(value="operator !=")
public boolean notEquals(@Const @ByRef
                                                                           ObjectPtr other)

Returns:

Whether two ObjectPtr equals each other