org.bytedeco.pytorch

Class StringSharedModuleDict

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.StringSharedModuleDict

All Implemented Interfaces:

AutoCloseable

@Name(value="torch::OrderedDict<std::string,std::shared_ptr<torch::nn::Module> >")
 @NoOffset
 @Properties(inherit=torch.class)
public class StringSharedModuleDict
extends Pointer

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

Method Summary

Modifier and Type	Method and Description
StringSharedModuleDictItem	back() Returns the very last item in the OrderedDict and throws an exception if it is empty.
StringSharedModuleDictItemVector.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)
StringSharedModuleDictItemVector.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)
Module	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.
Module	find(String key)
StringSharedModuleDictItem	front() Returns the very first item in the OrderedDict and throws an exception if it is empty.
Module	get(BytePointer key) Returns the value associated with the given key.
StringSharedModuleDictItem	get(long index) Returns the item at the index-th position in the OrderedDict.
Module	get(String key)
StringSharedModuleDict	getPointer(long i)
Module	insert(BytePointer key, Module value) Inserts a new (key, value) pair into the OrderedDict.
Module	insert(String key, Module value)
boolean	is_empty() Returns true if the OrderedDict contains no elements.
StringSharedModuleDictItemVector	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.
StringSharedModuleVector	pairs() Returns a newly allocated vector and copies all keys and values from this OrderedDict into a vector of std::pair<Key, Value>.
StringSharedModuleDict	position(long position)
StringSharedModuleDict	put(StringSharedModuleDict 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(StringSharedModuleDict other) Inserts all items from other into this OrderedDict.
SharedModuleVector	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

StringSharedModuleDict

public StringSharedModuleDict(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

StringSharedModuleDict

public StringSharedModuleDict(long size)

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

StringSharedModuleDict

public StringSharedModuleDict(@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.

StringSharedModuleDict

public StringSharedModuleDict()

StringSharedModuleDict

public StringSharedModuleDict(@StdString
                              String key_description)

StringSharedModuleDict

public StringSharedModuleDict(@Const @ByRef
                              StringSharedModuleDict other)

Copy constructs this OrderedDict from other.

Method Detail

position

public StringSharedModuleDict position(long position)

Overrides:

position in class Pointer

getPointer

public StringSharedModuleDict getPointer(long i)

Overrides:

getPointer in class Pointer

put

@ByRef
 @Name(value="operator =")
public StringSharedModuleDict put(@Const @ByRef
                                                                    StringSharedModuleDict 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 StringSharedModuleDictItem front()

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

back

@ByRef
public StringSharedModuleDictItem back()

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

get

@ByRef
 @Name(value="operator []")
public StringSharedModuleDictItem 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

@SharedPtr(value="torch::nn::Module")
 @ByRef
 @Name(value="operator []")
public Module 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

@SharedPtr(value="torch::nn::Module")
 @ByRef
 @Name(value="operator []")
public Module get(@StdString
                                                                                            String key)

find

@SharedPtr(value="torch::nn::Module")
 @NoException(value=true)
public Module 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

@SharedPtr(value="torch::nn::Module")
 @NoException(value=true)
public Module 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,std::shared_ptr<torch::nn::Module> >::Iterator*")
public StringSharedModuleDictItemVector.Iterator begin()

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

end

@ByVal
 @Cast(value="torch::OrderedDict<std::string,std::shared_ptr<torch::nn::Module> >::Iterator*")
public StringSharedModuleDictItemVector.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

public Module insert(BytePointer key,
                     Module 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

public Module insert(String key,
                     Module value)

update

public void update(@ByRef(value=true)
                   StringSharedModuleDict 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 StringSharedModuleDictItemVector 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 SharedModuleVector values()

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

pairs

@ByVal
public StringSharedModuleVector pairs()

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