org.bytedeco.pytorch.cuda

Class CUDAStreamArrayRef

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.cuda.CUDAStreamHeaderOnlyArrayRef

org.bytedeco.pytorch.cuda.CUDAStreamArrayRef

All Implemented Interfaces:

AutoCloseable

@Name(value="c10::ArrayRef<c10::cuda::CUDAStream>")
 @Properties(inherit=torch_cuda.class)
public class CUDAStreamArrayRef
extends CUDAStreamHeaderOnlyArrayRef

ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory), i.e. a start pointer and a length. It allows various APIs to take consecutive elements easily and conveniently. This class does not own the underlying data, it is expected to be used in situations where the data resides in some other buffer, whose lifetime extends past that of the ArrayRef. For this reason, it is not in general safe to store an ArrayRef. This is intended to be trivially copyable, so it should be passed by value. NOTE: We have refactored out the headeronly parts of the ArrayRef struct into HeaderOnlyArrayRef. As adding virtual would change the performance of the underlying constexpr calls, we rely on apparent-type dispatch for inheritance. This should be fine because their memory format is the same, and it is never incorrect for ArrayRef to call HeaderOnlyArrayRef methods. However, you should prefer to use ArrayRef when possible, because its use of TORCH_CHECK will lead to better user-facing error messages.

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
CUDAStreamArrayRef()
CUDAStreamArrayRef(CUDAStream begin, CUDAStream end)
CUDAStreamArrayRef(CUDAStream data, long length)
CUDAStreamArrayRef(long size) Native array allocator.
CUDAStreamArrayRef(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
CUDAStream	at(long Index) \} \name Operator Overloads \{
CUDAStream	back() back - Get the last element.
CUDAStream	front() \} \name Simple Operations, mostly inherited from HeaderOnlyArrayRef \{
CUDAStreamArrayRef	getPointer(long i)
CUDAStreamArrayRef	position(long position)
CUDAStreamArrayRef	slice(long N) slice(n) - Chop off the first N elements of the array.
CUDAStreamArrayRef	slice(long N, long M) slice(n, m) - Take M elements of the array starting at element N We deviate from HeaderOnlyArrayRef by using TORCH_CHECK instead of STD_TORCH_CHECK

Methods inherited from class org.bytedeco.pytorch.cuda.CUDAStreamHeaderOnlyArrayRef

data, empty, get, size, vec

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, trimMemory, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

CUDAStreamArrayRef

public CUDAStreamArrayRef()

CUDAStreamArrayRef

public CUDAStreamArrayRef(@Const
                          CUDAStream data,
                          @Cast(value="size_t")
                          long length)

CUDAStreamArrayRef

public CUDAStreamArrayRef(@Const
                          CUDAStream begin,
                          @Const
                          CUDAStream end)

CUDAStreamArrayRef

public CUDAStreamArrayRef(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

CUDAStreamArrayRef

public CUDAStreamArrayRef(long size)

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

Method Detail

position

public CUDAStreamArrayRef position(long position)

Overrides:

position in class CUDAStreamHeaderOnlyArrayRef

getPointer

public CUDAStreamArrayRef getPointer(long i)

Overrides:

getPointer in class CUDAStreamHeaderOnlyArrayRef

front

@Const
 @ByRef
public CUDAStream front()

\} \name Simple Operations, mostly inherited from HeaderOnlyArrayRef \{

front - Get the first element. We deviate from HeaderOnlyArrayRef by using TORCH_CHECK instead of STD_TORCH_CHECK

Overrides:

front in class CUDAStreamHeaderOnlyArrayRef

back

@Const
 @ByRef
public CUDAStream back()

back - Get the last element. We deviate from HeaderOnlyArrayRef by using TORCH_CHECK instead of STD_TORCH_CHECK

Overrides:

back in class CUDAStreamHeaderOnlyArrayRef

slice

@Const
 @ByVal
public CUDAStreamArrayRef slice(@Cast(value="size_t")
                                                 long N,
                                                 @Cast(value="size_t")
                                                 long M)

slice(n, m) - Take M elements of the array starting at element N We deviate from HeaderOnlyArrayRef by using TORCH_CHECK instead of STD_TORCH_CHECK

Overrides:

slice in class CUDAStreamHeaderOnlyArrayRef

slice

@Const
 @ByVal
public CUDAStreamArrayRef slice(@Cast(value="size_t")
                                                 long N)

slice(n) - Chop off the first N elements of the array. We deviate from HeaderOnlyArrayRef by using TORCH_CHECK instead of STD_TORCH_CHECK

Overrides:

slice in class CUDAStreamHeaderOnlyArrayRef

at

@Const
 @ByRef
public CUDAStream at(@Cast(value="size_t")
                                      long Index)

\} \name Operator Overloads \{

Vector compatibility We deviate from HeaderOnlyArrayRef by using TORCH_CHECK instead of STD_TORCH_CHECK

Overrides:

at in class CUDAStreamHeaderOnlyArrayRef