org.bytedeco.tvm

Class DataType

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tvm.DataType

All Implemented Interfaces:

AutoCloseable

@Namespace(value="tvm::runtime")
 @NoOffset
 @Properties(inherit=tvm_runtime.class)
public class DataType
extends Pointer

\brief Runtime primitive data type. This class is a thin wrapper of DLDataType. We also make use of DataType in compiler to store quick hint

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataType.TypeCode \brief Type code for the DataType.

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
DataType() \brief default constructor
DataType(DLDataType dtype) \brief Constructor
DataType(int code, int bits, int lanes)
DataType(int code, int bits, int lanes, boolean is_scalable) \brief Constructor
DataType(long size) Native array allocator.
DataType(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
DLDataType	asDLDataType() \brief Converter to DLDataType
static DataType	BFloat(int bits)
static DataType	BFloat(int bits, int lanes) \brief Construct an bfloat type.
int	bits()
static DataType	Bool()
static DataType	Bool(int lanes, boolean is_scalable) \brief Construct a bool type.
int	bytes()
int	code()
DataType	element_of() \brief Get the scalar version of the type.
boolean	equals(DataType other) \brief Equal comparator.
static DataType	Float(int bits)
static DataType	Float(int bits, int lanes) \brief Construct an float type.
int	get_lanes_or_vscale_factor()
DataType	getPointer(long i)
static DataType	Handle()
static DataType	Handle(int bits, int lanes) \brief Construct a handle type.
static DataType	Int(int bits)
static DataType	Int(int bits, int lanes) \brief Construct an int type.
boolean	is_bfloat16()
boolean	is_bool()
boolean	is_e4m3_float8()
boolean	is_e5m2_float8()
boolean	is_fixed_length_vector()
boolean	is_float()
boolean	is_float16()
boolean	is_float8()
boolean	is_handle()
boolean	is_int()
boolean	is_scalable_or_fixed_length_vector()
boolean	is_scalable_vector()
boolean	is_scalar()
boolean	is_uint()
boolean	is_vector_bool()
boolean	is_vector()
boolean	is_void()
int	lanes()
boolean	notEquals(DataType other) \brief NotEqual comparator.
static DataType	NVFloat8E4M3()
static DataType	NVFloat8E4M3(int lanes) \brief Construct NV float8 e4m3 datatype.
static DataType	NVFloat8E5M2()
static DataType	NVFloat8E5M2(int lanes) \brief Construct NV float8 e5m2 datatype.
DataType	position(long position)
DataType	put(DataType rhs) \brief Assignment operator.
static DataType	ShapeIndex() \brief Get the corresponding type of TVMShapeIndex.
static DataType	UInt(int bits)
static DataType	UInt(int bits, int lanes, boolean is_scalable) \brief Construct an uint type.
static DataType	Void() \brief Construct a Void type.
int	vscale_factor()
DataType	with_bits(int bits) \brief Create a new data type by change bits to a specified value.
DataType	with_lanes(int lanes) \brief Create a new data type by change lanes to a specified value.
DataType	with_scalable_vscale_factor(int vscale_factor) \brief Create a new scalable vector data type by changing the vscale multiplier to a specified value.

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

DataType

public DataType(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

DataType

public DataType(long size)

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

DataType

public DataType()

\brief default constructor

DataType

public DataType(@ByVal
                DLDataType dtype)

\brief Constructor

Parameters:

dtype - The DLDataType

DataType

public DataType(int code,
                int bits,
                int lanes,
                @Cast(value="bool")
                boolean is_scalable)

\brief Constructor

Parameters:

code - The type code.

bits - The number of bits in the type.

lanes - The number of lanes.

is_scalable - Whether the data type is scalable.

DataType

public DataType(int code,
                int bits,
                int lanes)

Method Detail

position

public DataType position(long position)

Overrides:

position in class Pointer

getPointer

public DataType getPointer(long i)

Overrides:

getPointer in class Pointer

code

public int code()

Returns:

The type code.

bits

public int bits()

Returns:

number of bits in the data.

bytes

public int bytes()

Returns:

number of bytes to store each scalar.

lanes

public int lanes()

Returns:

number of lanes in the data.

vscale_factor

public int vscale_factor()

Returns:

the integer multiplier of vscale in a scalable vector.

get_lanes_or_vscale_factor

public int get_lanes_or_vscale_factor()

Returns:

get vscale factor or lanes depending on scalability of the vector.

is_scalar

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

Returns:

whether type is a scalar type.

is_bool

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

Returns:

whether type is a scalar type.

is_float

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

Returns:

whether type is a float type.

is_float8

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

Returns:

whether type is a float8 type.

is_e4m3_float8

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

is_e5m2_float8

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

is_float16

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

Returns:

whether type is a float16 type.

is_bfloat16

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

Returns:

whether type is a bfloat16 type.

is_int

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

Returns:

whether type is an int type.

is_uint

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

Returns:

whether type is an uint type.

is_handle

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

Returns:

whether type is a handle type.

is_scalable_or_fixed_length_vector

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

Returns:

whether type is a vector type.

is_fixed_length_vector

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

Returns:

Whether the type is a fixed length vector.

is_scalable_vector

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

Returns:

Whether the type is a scalable vector.

is_vector

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

Returns:

whether type is a vector type.

is_vector_bool

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

Returns:

whether type is a bool vector type.

is_void

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

Returns:

whether type is a Void type.

with_lanes

@ByVal
public DataType with_lanes(int lanes)

\brief Create a new data type by change lanes to a specified value.

Parameters:

lanes - The target number of lanes.

Returns:

the result type.

with_scalable_vscale_factor

@ByVal
public DataType with_scalable_vscale_factor(int vscale_factor)

\brief Create a new scalable vector data type by changing the vscale multiplier to a specified value. We'll use the data_.lanes field for this value. @param vscale_factor The vscale multiplier. @return A copy of the old DataType with the number of scalable lanes.

with_bits

@ByVal
public DataType with_bits(int bits)

\brief Create a new data type by change bits to a specified value.

Parameters:

bits - The target number of bits.

Returns:

the result type.

element_of

@ByVal
public DataType element_of()

\brief Get the scalar version of the type.

Returns:

the result type.

put

@ByRef
 @Name(value="operator =")
public DataType put(@Const @ByRef
                                                        DataType rhs)

\brief Assignment operator.

equals

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

\brief Equal comparator.

Parameters:

other - The data type to compare against.

Returns:

The comparison result.

notEquals

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

\brief NotEqual comparator.

Parameters:

other - The data type to compare against.

Returns:

The comparison result.

asDLDataType

@ByVal
 @Name(value="operator DLDataType")
public DLDataType asDLDataType()

\brief Converter to DLDataType

Returns:

the result.

Int

@ByVal
public static DataType Int(int bits,
                                   int lanes)

\brief Construct an int type.

Parameters:

bits - The number of bits in the type.

lanes - The number of lanes.

Returns:

The constructed data type.

Int

@ByVal
public static DataType Int(int bits)

UInt

@ByVal
public static DataType UInt(int bits,
                                    int lanes,
                                    @Cast(value="bool")
                                    boolean is_scalable)

\brief Construct an uint type.

Parameters:

bits - The number of bits in the type.

lanes - The number of lanes.

is_scalable - Whether the data type is scalable.

Returns:

The constructed data type.

UInt

@ByVal
public static DataType UInt(int bits)

Float

@ByVal
public static DataType Float(int bits,
                                     int lanes)

\brief Construct an float type.

Parameters:

bits - The number of bits in the type.

lanes - The number of lanes

Returns:

The constructed data type.

Float

@ByVal
public static DataType Float(int bits)

BFloat

@ByVal
public static DataType BFloat(int bits,
                                      int lanes)

\brief Construct an bfloat type.

Parameters:

bits - The number of bits in the type.

lanes - The number of lanes

Returns:

The constructed data type.

BFloat

@ByVal
public static DataType BFloat(int bits)

NVFloat8E4M3

@ByVal
public static DataType NVFloat8E4M3(int lanes)

\brief Construct NV float8 e4m3 datatype.

Parameters:

lanes - The number of lanes

Returns:

The constructed data type.

NVFloat8E4M3

@ByVal
public static DataType NVFloat8E4M3()

NVFloat8E5M2

@ByVal
public static DataType NVFloat8E5M2(int lanes)

\brief Construct NV float8 e5m2 datatype.

Parameters:

lanes - The number of lanes

Returns:

The constructed data type.

NVFloat8E5M2

@ByVal
public static DataType NVFloat8E5M2()

Bool

@ByVal
public static DataType Bool(int lanes,
                                    @Cast(value="bool")
                                    boolean is_scalable)

\brief Construct a bool type.

Parameters:

lanes - The number of lanes.

is_scalable - Whether the data type is scalable.

Returns:

The constructed data type.

Bool

@ByVal
public static DataType Bool()

Handle

@ByVal
public static DataType Handle(int bits,
                                      int lanes)

\brief Construct a handle type.

Parameters:

bits - The number of bits in the type.

lanes - The number of lanes

Returns:

The constructed data type.

Handle

@ByVal
public static DataType Handle()

Void

@ByVal
public static DataType Void()

\brief Construct a Void type.

Returns:

The constructed data type.

ShapeIndex

@ByVal
public static DataType ShapeIndex()

\brief Get the corresponding type of TVMShapeIndex.

Returns:

The type of TVM shape index.