org.bytedeco.pytorch.cuda

Class CUDAStreamArrayRef

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.cuda.CUDAStreamArrayRef

All Implemented Interfaces:

AutoCloseable

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

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.

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() \name Constructors \{
CUDAStreamArrayRef(CUDAStream begin, CUDAStream end) Construct an ArrayRef from a range.
CUDAStreamArrayRef(CUDAStream data, long length) Construct an ArrayRef from a pointer and 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) Vector compatibility
CUDAStream	back() back - Get the last element.
CUDAStream	begin() \} \name Simple Operations \{
CUDAStream	cbegin()
CUDAStream	cend()
CUDAStream	data()
boolean	empty() empty - Check if the array is empty.
CUDAStream	end()
boolean	equals(CUDAStreamArrayRef RHS) equals - Check for element-wise equality.
CUDAStream	front() front - Get the first element.
CUDAStream	get(long Index) \} \name Operator Overloads \{
CUDAStreamArrayRef	getPointer(long i)
CUDAStreamArrayRef	position(long position)
long	size() size - Get the array size.
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
CUDAStream	vec() \} \name Expensive Operations \{

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

CUDAStreamArrayRef

public CUDAStreamArrayRef(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

CUDAStreamArrayRef

public CUDAStreamArrayRef(long size)

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

CUDAStreamArrayRef

public CUDAStreamArrayRef()

\name Constructors \{

Construct an empty ArrayRef.

CUDAStreamArrayRef

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

Construct an ArrayRef from a pointer and length.

CUDAStreamArrayRef

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

Construct an ArrayRef from a range.

Method Detail

position

public CUDAStreamArrayRef position(long position)

Overrides:

position in class Pointer

getPointer

public CUDAStreamArrayRef getPointer(long i)

Overrides:

getPointer in class Pointer

begin

@Const
 @ByPtr
public CUDAStream begin()

\} \name Simple Operations \{

end

@Const
 @ByPtr
public CUDAStream end()

cbegin

@Const
 @ByPtr
public CUDAStream cbegin()

cend

@Const
 @ByPtr
public CUDAStream cend()

empty

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

empty - Check if the array is empty.

data

@Const
public CUDAStream data()

size

@Cast(value="const size_t")
public long size()

size - Get the array size.

front

@Const
 @ByRef
public CUDAStream front()

front - Get the first element.

back

@Const
 @ByRef
public CUDAStream back()

back - Get the last element.

equals

@Cast(value="const bool")
public boolean equals(@ByVal
                                                 CUDAStreamArrayRef RHS)

equals - Check for element-wise equality.

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

slice

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

slice(n) - Chop off the first N elements of the array.

get

@Const
 @ByRef
 @Name(value="operator []")
public CUDAStream get(@Cast(value="size_t")
                                                                    long Index)

\} \name Operator Overloads \{

at

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

Vector compatibility

vec

@StdVector
public CUDAStream vec()

\} \name Expensive Operations \{