org.bytedeco.tvm

Class TVMObject

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tvm.TVMObject

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ADTObj, ArrayNode, ClosureObj, Container, MapNode, ModuleNode, PackedFuncObj, ShapeTupleObj, StringObj

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

\brief base class of all object containers. Sub-class of objects should declare the following static constexpr fields: - _type_index: Static type index of the object, if assigned to TypeIndex::kDynamic the type index will be assigned during runtime. Runtime type index can be accessed by ObjectType::TypeIndex(); - _type_key: The unique string identifier of the type. - _type_final: Whether the type is terminal type(there is no subclass of the type in the object system). This field is automatically set by macro TVM_DECLARE_FINAL_OBJECT_INFO It is still OK to sub-class a terminal object type T and construct it using make_object. But IsInstance check will only show that the object type is T(instead of the sub-class). The following two fields are necessary for base classes that can be sub-classed. - _type_child_slots: Number of reserved type index slots for child classes. Used for runtime optimization for type checking in IsInstance. If an object's type_index is within range of [type_index, type_index + _type_child_slots] Then the object can be quickly decided as sub-class of the current object class. If not, a fallback mechanism is used to check the global type table. Recommendation: set to estimate number of children needed. - _type_child_slots_can_overflow: Whether we can add additional child classes even if the number of child classes exceeds the _type_child_slots. A fallback mechanism to check global type table will be used. Recommendation: set to false for optimal runtime speed if we know exact number of children. Two macros are used to declare helper functions in the object: - Use TVM_DECLARE_BASE_OBJECT_INFO for object classes that can be sub-classed. - Use TVM_DECLARE_FINAL_OBJECT_INFO for object classes that cannot be sub-classed. New objects can be created using make_object function. Which will automatically populate the type_index and deleter of the object.

See Also:

make_object, ObjectPtr,

{@code

  // Create a base object
  class BaseObj : public Object {
   public:
    // object fields
    int field0;

    // object properties
    static constexpr const uint32_t _type_index = TypeIndex::kDynamic;
    static constexpr const char* _type_key = "test.BaseObj";
    TVM_DECLARE_BASE_OBJECT_INFO(BaseObj, Object);
  };

  class LeafObj : public BaseObj {
   public:
    // fields
    int child_field0;
    // object properties
    static constexpr const uint32_t _type_index = TypeIndex::kDynamic;
    static constexpr const char* _type_key = "test.LeafObj";
    TVM_DECLARE_BASE_OBJECT_INFO(LeafObj, Object);
  };

  // The following code should be put into a cc file.
  TVM_REGISTER_OBJECT_TYPE(BaseObj);
  TVM_REGISTER_OBJECT_TYPE(LeafObj);

  // Usage example.
  void TestObjects() {
    // create an object
    ObjectRef leaf_ref(make_object());
    // cast to a specific instance
    const LeafObj* leaf_ptr = leaf_ref.as();
    ICHECK(leaf_ptr != nullptr);
    // can also cast to the base class.
    ICHECK(leaf_ref.as() != nullptr);
  }

 }

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TVMObject.FDeleter \brief Object deleter

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	_type_child_slots
static boolean	_type_child_slots_can_overflow
static boolean	_type_final
static boolean	_type_has_method_sequal_reduce
static boolean	_type_has_method_shash_reduce
static boolean	_type_has_method_visit_attrs
static int	_type_index

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
TVMObject()
TVMObject(long size) Native array allocator.
TVMObject(Pointer p) Pointer cast constructor.
TVMObject(TVMObject other)

Method Summary

Modifier and Type	Method and Description
static int	_GetOrAllocRuntimeTypeIndex()
static boolean	_type_child_slots_can_overflow()
static int	_type_child_slots()
static boolean	_type_final()
static boolean	_type_has_method_sequal_reduce()
static boolean	_type_has_method_shash_reduce()
static boolean	_type_has_method_visit_attrs()
static int	_type_index()
static BytePointer	_type_key()
TVMObject	getPointer(long i)
BytePointer	GetTypeKey()
long	GetTypeKeyHash()
TVMObject	position(long position)
TVMObject	put(TVMObject other)
static int	RuntimeTypeIndex()
int	type_index()
static BytePointer	TypeIndex2Key(int tindex) \brief Get the type key of the corresponding index from runtime.
static long	TypeIndex2KeyHash(int tindex) \brief Get the type key hash of the corresponding index from runtime.
static int	TypeKey2Index(BytePointer key) \brief Get the type index of the corresponding key from runtime.
static int	TypeKey2Index(String key)
boolean	unique()

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

Field Detail

_type_final

public static final boolean _type_final

_type_child_slots

public static final int _type_child_slots

_type_child_slots_can_overflow

public static final boolean _type_child_slots_can_overflow

_type_has_method_visit_attrs

public static final boolean _type_has_method_visit_attrs

_type_has_method_sequal_reduce

public static final boolean _type_has_method_sequal_reduce

_type_has_method_shash_reduce

public static final boolean _type_has_method_shash_reduce

_type_index

public static final int _type_index

Constructor Detail

TVMObject

public TVMObject(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

TVMObject

public TVMObject(long size)

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

TVMObject

public TVMObject()

TVMObject

public TVMObject(@Const @ByRef
                 TVMObject other)

Method Detail

position

public TVMObject position(long position)

Overrides:

position in class Pointer

getPointer

public TVMObject getPointer(long i)

Overrides:

getPointer in class Pointer

type_index

@Cast(value="uint32_t")
public int type_index()

Returns:

The internal runtime type index of the object.

GetTypeKey

@StdString
public BytePointer GetTypeKey()

Returns:

the type key of the object. \note this operation is expensive, can be used for error reporting.

GetTypeKeyHash

@Cast(value="size_t")
public long GetTypeKeyHash()

Returns:

A hash value of the return of GetTypeKey.

unique

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

Returns:

Whether the cell has only one reference \note We use stl style naming to be consistent with known API in shared_ptr.

TypeIndex2Key

@StdString
public static BytePointer TypeIndex2Key(@Cast(value="uint32_t")
                                                    int tindex)

\brief Get the type key of the corresponding index from runtime.

Parameters:

tindex - The type index.

Returns:

the result.

TypeIndex2KeyHash

@Cast(value="size_t")
public static long TypeIndex2KeyHash(@Cast(value="uint32_t")
                                                            int tindex)

\brief Get the type key hash of the corresponding index from runtime.

Parameters:

tindex - The type index.

Returns:

the related key-hash.

TypeKey2Index

@Cast(value="uint32_t")
public static int TypeKey2Index(@StdString
                                                         BytePointer key)

\brief Get the type index of the corresponding key from runtime.

Parameters:

key - The type key.

Returns:

the result.

TypeKey2Index

@Cast(value="uint32_t")
public static int TypeKey2Index(@StdString
                                                         String key)

_type_key

@MemberGetter
 @Cast(value="const char*")
public static BytePointer _type_key()

_GetOrAllocRuntimeTypeIndex

@Cast(value="uint32_t")
public static int _GetOrAllocRuntimeTypeIndex()

RuntimeTypeIndex

@Cast(value="uint32_t")
public static int RuntimeTypeIndex()

_type_final

@MemberGetter
 @Cast(value="const bool")
public static boolean _type_final()

_type_child_slots

@MemberGetter
 @Cast(value="const uint32_t")
public static int _type_child_slots()

_type_child_slots_can_overflow

@MemberGetter
 @Cast(value="const bool")
public static boolean _type_child_slots_can_overflow()

_type_has_method_visit_attrs

@MemberGetter
 @Cast(value="const bool")
public static boolean _type_has_method_visit_attrs()

_type_has_method_sequal_reduce

@MemberGetter
 @Cast(value="const bool")
public static boolean _type_has_method_sequal_reduce()

_type_has_method_shash_reduce

@MemberGetter
 @Cast(value="const bool")
public static boolean _type_has_method_shash_reduce()

_type_index

@MemberGetter
 @Cast(value="const uint32_t")
public static int _type_index()

put

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