org.bytedeco.pytorch

Class GenericDict

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.GenericDict

All Implemented Interfaces:

AutoCloseable

@Name(value="c10::Dict<c10::IValue,c10::IValue>")
 @NoOffset
 @Properties(inherit=torch.class)
public class GenericDict
extends Pointer

An object of this class stores a map from Key to Value. This is a pointer type. After a copy, both Dicts will share the same storage: > Dict a; > Dict b = a; > b.insert(3, "three"); > ASSERT("three" == a.at(3)); We use this class in the PyTorch kernel API because that allows us to do optimizations and switch out the underlying map implementation without breaking backwards compatibility for the kernel API.

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
GenericDict(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
IValue	at(IValue key) Returns the mapped value of the element with key equivalent to key.
GenericDictIterator	begin() Returns an iterator to the first element of the container.
void	clear() Erases all elements from the container.
boolean	contains(IValue key) Checks if there is an element with key equivalent to key in the container.
GenericDict	copy() Create a new Dict pointing to a deep copy of the same data.
boolean	empty() Checks if the container has no elements.
GenericDictIterator	end() Returns an iterator to the element following the last element of the container.
void	erase(GenericDictIterator iter) Removes the element pointed to by iter.
long	erase(IValue key) Removes the element with the given key, if it exists.
GenericDictIterator	find(IValue key) Finds an element with key equivalent to key.
boolean	is(GenericDict rhs) Identity comparison.
Type.TypePtr	keyType()
GenericDict	put(GenericDict arg0) Create a generic dict with runtime type information.
void	reserve(long count) Increase the capacity so that at least count elements can be stored without having to reallocate or rehash.
long	size() Returns the number of elements in the container.
void	unsafeSetKeyType(Type.TypePtr t)
void	unsafeSetValueType(Type.TypePtr t)
Type.TypePtr	valueType()

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, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, 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

GenericDict

public GenericDict(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

put

@ByRef
 @Name(value="operator =")
public GenericDict put(@Const @ByRef
                                                         GenericDict arg0)

Create a generic dict with runtime type information. This only works for c10::impl::GenericDict and is not part of the public API but only supposed to be used internally by PyTorch.

copy

@ByVal
public GenericDict copy()

Create a new Dict pointing to a deep copy of the same data. The Dict returned is a new dict with separate storage. Changes in it are not reflected in the original dict or vice versa.

begin

@ByVal
public GenericDictIterator begin()

Returns an iterator to the first element of the container. If the container is empty, the returned iterator will be equal to end().

end

@ByVal
public GenericDictIterator end()

Returns an iterator to the element following the last element of the container. This element acts as a placeholder; attempting to access it results in undefined behavior.

empty

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

Checks if the container has no elements.

size

@Cast(value="c10::Dict<c10::IValue,c10::IValue>::size_type")
public long size()

Returns the number of elements in the container.

clear

public void clear()

Erases all elements from the container. After this call, size() returns zero. Invalidates any references, pointers, or iterators referring to contained elements. May also invalidate past-the-end iterators.

erase

public void erase(@ByVal
                  GenericDictIterator iter)

Removes the element pointed to by iter. May invalidate any references, pointers, or iterators referring to contained elements. The iterator iter must be valid and dereferenceable. Thus the end() iterator (which is valid, but is not dereferenceable) cannot be used as a value for iter.

erase

@Cast(value="size_t")
public long erase(@Const @ByRef
                                        IValue key)

Removes the element with the given key, if it exists. May invalidate any references, pointers, or iterators referring to contained elements.

Returns:

The number of elements removed. This is either '1' if an element with the key existed, or '0' if it didn't.

at

@ByVal
public IValue at(@Const @ByRef
                        IValue key)

Returns the mapped value of the element with key equivalent to key. If no such element exists, an exception of type std::out_of_range is thrown.

find

@ByVal
public GenericDictIterator find(@Const @ByRef
                                       IValue key)

Finds an element with key equivalent to key.

Returns:

Iterator to an element with key equivalent to key. If no such element is found, past-the-end (see end()) iterator is returned.

contains

@Cast(value="bool")
public boolean contains(@Const @ByRef
                                            IValue key)

Checks if there is an element with key equivalent to key in the container.

Returns:

true if there is such an element, otherwise false.

reserve

public void reserve(@Cast(value="c10::Dict<c10::IValue,c10::IValue>::size_type")
                    long count)

Increase the capacity so that at least count elements can be stored without having to reallocate or rehash.

is

@Cast(value="bool")
public boolean is(@Const @ByRef
                                      GenericDict rhs)

Identity comparison. Returns true if and only if rhs represents the same Dict object as this.

keyType

@ByVal
public Type.TypePtr keyType()

valueType

@ByVal
public Type.TypePtr valueType()

unsafeSetKeyType

public void unsafeSetKeyType(@ByVal
                             Type.TypePtr t)

unsafeSetValueType

public void unsafeSetValueType(@ByVal
                               Type.TypePtr t)