org.bytedeco.pytorch

Class StringTensorDict

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.StringTensorDict

All Implemented Interfaces:

AutoCloseable

@Name(value="torch::OrderedDict<std::string,torch::Tensor>")
 @NoOffset
 @Properties(inherit=torch.class)
public class StringTensorDict
extends Pointer

An ordered dictionary implementation, akin to Python's OrderedDict.

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
StringTensorDict()
StringTensorDict(BytePointer key_description) Constructs the OrderedDict with a short description of the kinds of keys stored in the OrderedDict.
StringTensorDict(long size) Native array allocator.
StringTensorDict(Pointer p) Pointer cast constructor.
StringTensorDict(String key_description)
StringTensorDict(StringTensorDict other) Copy constructs this OrderedDict from other.

Method Summary

Modifier and Type	Method and Description
StringTensorDictItem	back() Returns the very last item in the OrderedDict and throws an exception if it is empty.
StringTensorDictItemVector.Iterator	begin() Returns an iterator to the first item in the OrderedDict.
void	clear() Removes all items from this OrderedDict.
boolean	contains(BytePointer key) Returns true if the key is present in the OrderedDict.
boolean	contains(String key)
StringTensorDictItemVector.Iterator	end() Returns an iterator one past the last item in the OrderedDict.
void	erase(BytePointer key) Removes the item that has key from this OrderedDict if exists and if it doesn't an exception is thrown.
void	erase(String key)
Tensor	find(BytePointer key) Returns a pointer to the value associated with the given key, or a nullptr if no such key is stored in the OrderedDict.
Tensor	find(String key)
StringTensorDictItem	front() Returns the very first item in the OrderedDict and throws an exception if it is empty.
Tensor	get(BytePointer key) Returns the value associated with the given key.
StringTensorDictItem	get(long index) Returns the item at the index-th position in the OrderedDict.
Tensor	get(String key)
StringTensorDict	getPointer(long i)
Tensor	insert(BytePointer key, Tensor value) Inserts a new (key, value) pair into the OrderedDict.
Tensor	insert(String key, Tensor value)
boolean	is_empty() Returns true if the OrderedDict contains no elements.
StringTensorDictItemVector	items() Returns the items stored in the OrderedDict.
BytePointer	key_description() Returns the key description string the OrderedDict was constructed with.
StringVector	keys() Returns a newly allocated vector and copies all keys from this OrderedDict into the vector.
StringTensorVector	pairs() Returns a newly allocated vector and copies all keys and values from this OrderedDict into a vector of std::pair<Key, Value>.
StringTensorDict	position(long position)
StringTensorDict	put(StringTensorDict other) Assigns items from other to this OrderedDict.
void	reserve(long requested_capacity) Resizes internal storage to fit at least requested_capacity items without requiring reallocation.
long	size() Returns the number of items currently stored in the OrderedDict.
void	update(StringTensorDict other) Inserts all items from other into this OrderedDict.
TensorVector	values() Returns a newly allocated vector and copies all values from this OrderedDict into the vector.

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

StringTensorDict

public StringTensorDict(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

StringTensorDict

public StringTensorDict(long size)

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

StringTensorDict

public StringTensorDict(@StdString
                        BytePointer key_description)

Constructs the OrderedDict with a short description of the kinds of keys stored in the OrderedDict. This description is used in error messages thrown by the OrderedDict.

StringTensorDict

public StringTensorDict()

StringTensorDict

public StringTensorDict(@StdString
                        String key_description)

StringTensorDict

public StringTensorDict(@Const @ByRef
                        StringTensorDict other)

Copy constructs this OrderedDict from other.

Method Detail

position

public StringTensorDict position(long position)

Overrides:

position in class Pointer

getPointer

public StringTensorDict getPointer(long i)

Overrides:

getPointer in class Pointer

put

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

Assigns items from other to this OrderedDict.

key_description

@StdString
 @NoException(value=true)
public BytePointer key_description()

Returns the key description string the OrderedDict was constructed with.

front

@ByRef
public StringTensorDictItem front()

Returns the very first item in the OrderedDict and throws an exception if it is empty.

back

@ByRef
public StringTensorDictItem back()

Returns the very last item in the OrderedDict and throws an exception if it is empty.

get

@ByRef
 @Name(value="operator []")
public StringTensorDictItem get(@Cast(value="size_t")
                                                                   long index)

Returns the item at the index-th position in the OrderedDict. Throws an exception if the index is out of bounds.

get

@ByRef
 @Name(value="operator []")
public Tensor get(@StdString
                                                     BytePointer key)

Returns the value associated with the given key. Throws an exception if no such key is stored in the OrderedDict. Use find() for a non-throwing way of accessing a value if it is present.

get

@ByRef
 @Name(value="operator []")
public Tensor get(@StdString
                                                     String key)

find

@NoException(value=true)
public Tensor find(@StdString
                                            BytePointer key)

Returns a pointer to the value associated with the given key, or a nullptr if no such key is stored in the OrderedDict.

find

@NoException(value=true)
public Tensor find(@StdString
                                            String key)

contains

@Cast(value="bool")
 @NoException(value=true)
public boolean contains(@StdString
                                                                      BytePointer key)

Returns true if the key is present in the OrderedDict.

contains

@Cast(value="bool")
 @NoException(value=true)
public boolean contains(@StdString
                                                                      String key)

begin

@ByVal
 @Cast(value="torch::OrderedDict<std::string,torch::Tensor>::Iterator*")
public StringTensorDictItemVector.Iterator begin()

Returns an iterator to the first item in the OrderedDict. Iteration is ordered.

end

@ByVal
 @Cast(value="torch::OrderedDict<std::string,torch::Tensor>::Iterator*")
public StringTensorDictItemVector.Iterator end()

Returns an iterator one past the last item in the OrderedDict.

size

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

Returns the number of items currently stored in the OrderedDict.

is_empty

@Cast(value="bool")
 @NoException(value=true)
public boolean is_empty()

Returns true if the OrderedDict contains no elements.

reserve

public void reserve(@Cast(value="size_t")
                    long requested_capacity)

Resizes internal storage to fit at least requested_capacity items without requiring reallocation.

insert

@ByRef
public Tensor insert(@StdString
                            BytePointer key,
                            @ByRef(value=true)
                            Tensor value)

Inserts a new (key, value) pair into the OrderedDict. Throws an exception if the key is already present. If insertion is successful, immediately returns a reference to the inserted value.

insert

@ByRef
public Tensor insert(@StdString
                            String key,
                            @ByRef(value=true)
                            Tensor value)

update

public void update(@ByRef(value=true)
                   StringTensorDict other)

Inserts all items from other into this OrderedDict. If any key from other is already present in this OrderedDict, an exception is thrown.

erase

public void erase(@StdString
                  BytePointer key)

Removes the item that has key from this OrderedDict if exists and if it doesn't an exception is thrown.

erase

public void erase(@StdString
                  String key)

clear

public void clear()

Removes all items from this OrderedDict.

items

@Const
 @ByRef
 @NoException(value=true)
public StringTensorDictItemVector items()

Returns the items stored in the OrderedDict.

keys

@ByVal
public StringVector keys()

Returns a newly allocated vector and copies all keys from this OrderedDict into the vector.

values

@ByVal
public TensorVector values()

Returns a newly allocated vector and copies all values from this OrderedDict into the vector.

pairs

@ByVal
public StringTensorVector pairs()

Returns a newly allocated vector and copies all keys and values from this OrderedDict into a vector of std::pair<Key, Value>.