org.bytedeco.tvm

Class TVMString

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tvm.ObjectRef

org.bytedeco.tvm.TVMString

All Implemented Interfaces:

AutoCloseable

@Name(value="tvm::runtime::String")
 @NoOffset
 @Properties(inherit=tvm_runtime.class)
public class TVMString
extends ObjectRef

\brief Reference to string objects.

 // Example to create runtime String reference object from std::string
 std::string s = "hello world";

 // You can create the reference from existing std::string
 String ref{std::move(s)};

 // You can rebind the reference to another string.
 ref = std::string{"hello world2"};

 // You can use the reference as hash map key
 std::unordered_map<String, int32_t> m;
 m[ref] = 1;

 // You can compare the reference object with other string objects
 assert(ref == "hello world", true);

 // You can convert the reference to std::string again
 string s2 = (string)ref;

 

Nested Class Summary

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 boolean	_type_is_nullable

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
TVMString() \brief Construct an empty string.
TVMString(BytePointer other) \brief Construct a new String object
TVMString(long size) Native array allocator.
TVMString(ObjectPtr n)
TVMString(Pointer p) Pointer cast constructor.
TVMString(String other)
TVMString(TVMString other)

Method Summary

Modifier and Type	Method and Description
static boolean	_type_is_nullable()
StringObj	access()
BytePointer	asBytePointer() \brief Convert String to an std::string object
byte	at(long pos) \brief Read an element.
BytePointer	c_str() \brief Returns a pointer to the char array in the string.
static boolean	CanConvertFrom(TVMArgValue val) \brief Check if a TVMArgValue can be converted to String, i.e.
int	compare(BytePointer other) \brief Compares this String object to other
int	compare(String other)
int	compare(TVMString other) \brief Compares this String object to other
BytePointer	data() \brief Return the data pointer
boolean	empty() \brief Retun if the string is empty
StringObj	get()
TVMString	getPointer(long i)
static long	HashBytes(BytePointer data, long size) \brief Hash the binary bytes
static long	HashBytes(String data, long size)
long	length() \brief Return the length of the string
TVMString	position(long position)
TVMString	put(BytePointer other) \brief Change the value the reference object points to.
TVMString	put(String other)
TVMString	put(TVMString other)
long	size() \brief Return the length of the string

Methods inherited from class org.bytedeco.tvm.ObjectRef

defined, equals, lessThan, notEquals, same_as, unique, 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

Field Detail

_type_is_nullable

public static final boolean _type_is_nullable

Constructor Detail

TVMString

public TVMString(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

TVMString

public TVMString(long size)

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

TVMString

public TVMString()

\brief Construct an empty string.

TVMString

public TVMString(@StdString
                 BytePointer other)

\brief Construct a new String object

Parameters:

other - The moved/copied std::string object \note If user passes const reference, it will trigger copy. If it's rvalue, it will be moved into other.

TVMString

public TVMString(@StdString
                 String other)

TVMString

public TVMString(@ByVal
                 ObjectPtr n)

TVMString

public TVMString(@Const @ByRef
                 TVMString other)

Method Detail

position

public TVMString position(long position)

Overrides:

position in class ObjectRef

getPointer

public TVMString getPointer(long i)

Overrides:

getPointer in class ObjectRef

put

@ByRef
 @Name(value="operator =")
public TVMString put(@StdString
                                                         BytePointer other)

\brief Change the value the reference object points to.

Parameters:

other - The value for the new String

put

@ByRef
 @Name(value="operator =")
public TVMString put(@StdString
                                                         String other)

compare

public int compare(@Const @ByRef
                   TVMString other)

\brief Compares this String object to other

Parameters:

other - The String to compare with.

Returns:

zero if both char sequences compare equal. negative if this appear before other, positive otherwise.

compare

public int compare(@StdString
                   BytePointer other)

\brief Compares this String object to other

Parameters:

other - The string to compare with.

Returns:

zero if both char sequences compare equal. negative if this appear before other, positive otherwise.

compare

public int compare(@StdString
                   String other)

c_str

@Cast(value="const char*")
public BytePointer c_str()

\brief Returns a pointer to the char array in the string.

Returns:

const char*

size

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

\brief Return the length of the string

Returns:

size_t string length

length

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

\brief Return the length of the string

Returns:

size_t string length

empty

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

\brief Retun if the string is empty

Returns:

true if empty, false otherwise.

at

@Cast(value="char")
public byte at(@Cast(value="size_t")
                                    long pos)

\brief Read an element.

Parameters:

pos - The position at which to read the character.

Returns:

The char at position

data

@Cast(value="const char*")
public BytePointer data()

\brief Return the data pointer

Returns:

const char* data pointer

asBytePointer

@Name(value="operator std::string")
 @StdString
public BytePointer asBytePointer()

\brief Convert String to an std::string object

Returns:

std::string

CanConvertFrom

@Cast(value="bool")
public static boolean CanConvertFrom(@Const @ByRef
                                                          TVMArgValue val)

\brief Check if a TVMArgValue can be converted to String, i.e. it can be std::string or String

Parameters:

val - The value to be checked

Returns:

A boolean indicating if val can be converted to String

HashBytes

@Cast(value="size_t")
public static long HashBytes(@Cast(value="const char*")
                                                    BytePointer data,
                                                    @Cast(value="size_t")
                                                    long size)

\brief Hash the binary bytes

Parameters:

data - The data pointer

size - The size of the bytes.

Returns:

the hash value.

HashBytes

@Cast(value="size_t")
public static long HashBytes(String data,
                                                    @Cast(value="size_t")
                                                    long size)

put

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

access

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

Overrides:

access in class ObjectRef

Returns:

the internal object pointer

get

@Const
public StringObj get()

Overrides:

get in class ObjectRef

Returns:

the internal object pointer

_type_is_nullable

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