org.bytedeco.pytorch

Class JavaDistributedRandomTensorDataLoaderBase

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.JavaDistributedRandomTensorDataLoaderBase

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

JavaDistributedRandomTensorDataLoader

@Name(value="torch::data::DataLoaderBase<JavaCPP_javacpp_0003a_0003aDataset_0003ctorch_0003a_0003aTensor_0002ctorch_0003a_0003adata_0003a_0003aexample_0003a_0003aNoTarget_0003e,JavaCPP_javacpp_0003a_0003aDataset_0003ctorch_0003a_0003aTensor_0002ctorch_0003a_0003adata_0003a_0003aexample_0003a_0003aNoTarget_0003e::BatchType,torch::data::samplers::DistributedRandomSampler::BatchRequestType>")
 @NoOffset
 @Properties(inherit=torch.class)
public class JavaDistributedRandomTensorDataLoaderBase
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
JavaDistributedRandomTensorDataLoaderBase(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
TensorExampleVectorIterator	begin() Returns an iterator into the DataLoader.
TensorExampleVectorIterator	end() Returns a special "sentinel" iterator that compares equal with a non-sentinel iterator once the DataLoader is exhausted.
void	join() Joins the DataLoader's worker threads and drains internal queues.
FullDataLoaderOptions	options() Returns the options with which the DataLoader was configured.

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

JavaDistributedRandomTensorDataLoaderBase

public JavaDistributedRandomTensorDataLoaderBase(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

begin

@ByVal
public TensorExampleVectorIterator begin()

Returns an iterator into the DataLoader. The lifetime of the iterator is bound to the DataLoader. In C++ standards language, the category of the iterator is OutputIterator. See https://en.cppreference.com/w/cpp/named_req/OutputIterator for what this means. In short: you may increment the iterator and dereference it, but cannot go back, or step forward more than one position at a time. When the DataLoader is exhausted, it will compare equal with the special "sentinel" iterator returned by DataLoader::end(). Most of the time, you should only use range-for loops to loop over the DataLoader, but standard algorithms like std::copy(dataloader.begin(), dataloader.end(), output_iterator) are supported too.

end

@ByVal
public TensorExampleVectorIterator end()

Returns a special "sentinel" iterator that compares equal with a non-sentinel iterator once the DataLoader is exhausted.

join

public void join()

Joins the DataLoader's worker threads and drains internal queues. This function may only be invoked from the main thread (in which the DataLoader lives).

options

@Const
 @ByRef
 @NoException(value=true)
public FullDataLoaderOptions options()

Returns the options with which the DataLoader was configured.