org.bytedeco.pytorch

Class Generator

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.Generator

All Implemented Interfaces:

AutoCloseable

@Namespace(value="at")
 @NoOffset
 @Properties(inherit=torch.class)
public class Generator
extends Pointer

Note [Acquire lock when using random generators] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Generator and its derived classes are NOT thread-safe. Please note that most of the places where we have inserted locking for generators are historically based, and we haven't actually checked that everything is truly thread safe (and it probably isn't). Please use the public mutex_ when using any methods from these classes, except for the read-only methods. You can learn about the usage by looking into the unittests (aten/src/ATen/cpu_generator_test.cpp) and other places where we have used lock_guard. TODO: Look into changing the threading semantics of Generators in ATen (e.g., making them non-thread safe and instead making the generator state splittable, to accommodate forks into other threads).

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
Generator()
Generator(GeneratorImplPtr gen_impl)
Generator(long size) Native array allocator.
Generator(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Generator	clone()
long	current_seed()
boolean	defined()
Device	device()
boolean	equals(Generator rhs)
long	get_offset()
Tensor	get_state()
GeneratorImplPtr	getIntrusivePtr()
Generator	getPointer(long i)
DispatchKeySet	key_set()
boolean	notEquals(Generator rhs)
Generator	position(long position)
Pointer	pyobj()
long	seed()
void	set_current_seed(long seed)
void	set_offset(long offset)
void	set_pyobj(Pointer pyobj)
void	set_state(Tensor new_state)
GeneratorImpl	unsafeGetGeneratorImpl()
GeneratorImpl	unsafeReleaseGeneratorImpl()

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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Generator

public Generator(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Generator

public Generator(long size)

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

Generator

public Generator()

Generator

public Generator(@ByVal
                 GeneratorImplPtr gen_impl)

Method Detail

position

public Generator position(long position)

Overrides:

position in class Pointer

getPointer

public Generator getPointer(long i)

Overrides:

getPointer in class Pointer

equals

@Cast(value="bool")
 @Name(value="operator ==")
public boolean equals(@Const @ByRef
                                                                      Generator rhs)

notEquals

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

defined

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

unsafeGetGeneratorImpl

public GeneratorImpl unsafeGetGeneratorImpl()

unsafeReleaseGeneratorImpl

public GeneratorImpl unsafeReleaseGeneratorImpl()

getIntrusivePtr

@Const
 @ByRef
public GeneratorImplPtr getIntrusivePtr()

set_current_seed

public void set_current_seed(@Cast(value="uint64_t")
                             long seed)

set_offset

public void set_offset(@Cast(value="uint64_t")
                       long offset)

get_offset

@Cast(value="uint64_t")
public long get_offset()

current_seed

@Cast(value="uint64_t")
public long current_seed()

seed

@Cast(value="uint64_t")
public long seed()

set_state

public void set_state(@Const @ByRef
                      Tensor new_state)

get_state

@ByVal
public Tensor get_state()

key_set

@ByVal
public DispatchKeySet key_set()

device

@ByVal
public Device device()

set_pyobj

@NoException(value=true)
public void set_pyobj(@Cast(value="PyObject*")
                                               Pointer pyobj)

pyobj

@Cast(value="PyObject*")
 @NoException(value=true)
public Pointer pyobj()

clone

@ByVal
public Generator clone()

Overrides:

clone in class Object