org.bytedeco.javacpp

Class LongPointer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.LongPointer

All Implemented Interfaces:

AutoCloseable

@Properties(inherit=javacpp.class)
public class LongPointer
extends Pointer

The peer class to native pointers and arrays of long long. All operations take into account the position and limit, when appropriate.

Author:

Samuel Audet

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.DeallocatorReference, Pointer.DeallocatorThread, Pointer.NativeDeallocator, Pointer.ProxyDeallocator, Pointer.ReferenceCounter

Field Summary

Fields

Modifier and Type	Field and Description
private static Logger	logger

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, deallocatorThread, limit, maxBytes, maxPhysicalBytes, maxRetries, position

Constructor Summary

Constructors

Constructor and Description
LongPointer()
LongPointer(long... array) Allocates enough memory for the array and copies it.
LongPointer(long size) Allocates a native long long array of the given size.
LongPointer(LongBuffer buffer) For direct buffers, calls Pointer(Buffer), while for buffers backed with an array, allocates enough memory for the array and copies it.
LongPointer(Pointer p)

Method Summary

Modifier and Type	Method and Description
private void	allocateArray(long size)
LongBuffer	asBuffer() Same as Pointer.asByteBuffer(), but can be overridden to return subclasses of Buffer.
LongPointer	capacity(long capacity) Sets the capacity and returns this.
long	get()
long	get(long i)
LongPointer	get(long[] array)
LongPointer	get(long[] array, int offset, int length) Reads a portion of the native array into a Java array.
LongPointer	getPointer(long i) Returns getPointer(getClass(), i).
LongPointer	limit(long limit) Sets the limit and returns this.
LongPointer	position(long position) Sets the position and returns this.
LongPointer	put(long... array)
LongPointer	put(long l)
LongPointer	put(long[] array, int offset, int length) Writes a portion of a Java array into the native array.
LongPointer	put(long i, long l) Copies the long long value to the i-th element of a native array.
int	sizeof() Returns 1 for Pointer or BytePointer else Loader.sizeof(getClass()) or -1 on error.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asByteBuffer, availablePhysicalBytes, calloc, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, init, interruptDeallocatorThread, isNull, isNull, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

Constructor Detail

LongPointer

public LongPointer(long... array)

Allocates enough memory for the array and copies it.

Parameters:

array - the array to copy

See Also:

put(long[])

LongPointer

public LongPointer(LongBuffer buffer)

For direct buffers, calls Pointer(Buffer), while for buffers backed with an array, allocates enough memory for the array and copies it.

Parameters:

buffer - the Buffer to reference or copy

See Also:

put(long[])

LongPointer

public LongPointer(long size)

Allocates a native long long array of the given size.

Parameters:

size - the number of long long elements to allocate

LongPointer

public LongPointer()

See Also:

Pointer()

LongPointer

public LongPointer(Pointer p)

See Also:

Pointer(Pointer)

Method Detail

allocateArray

private void allocateArray(long size)

position

public LongPointer position(long position)

Description copied from class: Pointer

Sets the position and returns this. That makes the array.position(i) statement sort of equivalent to the array[i] statement in C++.

Overrides:

position in class Pointer

Parameters:

position - the new position

Returns:

this

See Also:

Pointer.position(long)

limit

public LongPointer limit(long limit)

Description copied from class: Pointer

Sets the limit and returns this. Used to limit the size of an operation on this object.

Overrides:

limit in class Pointer

Parameters:

limit - the new limit

Returns:

this

See Also:

Pointer.limit(long)

capacity

public LongPointer capacity(long capacity)

Description copied from class: Pointer

Sets the capacity and returns this. Should not be called more than once after allocation.

Overrides:

capacity in class Pointer

Parameters:

capacity - the new capacity

Returns:

this

See Also:

Pointer.capacity(long)

sizeof

public int sizeof()

Description copied from class: Pointer

Returns 1 for Pointer or BytePointer else Loader.sizeof(getClass()) or -1 on error.

Overrides:

sizeof in class Pointer

getPointer

public LongPointer getPointer(long i)

Description copied from class: Pointer

Returns getPointer(getClass(), i).

Overrides:

getPointer in class Pointer

get

public long get()

Returns:

get(0)

get

public long get(long i)

Returns:

the i-th long long of a native array

put

public LongPointer put(long l)

Returns:

put(0, l)

put

public LongPointer put(long i,
                       long l)

Copies the long long value to the i-th element of a native array.

Parameters:

i - the index into the array

l - the long long value to copy

Returns:

this

get

public LongPointer get(long[] array)

Returns:

get(array, 0, array.length)

put

public LongPointer put(long... array)

Returns:

put(array, 0, array.length)

get

public LongPointer get(long[] array,
                       int offset,
                       int length)

Reads a portion of the native array into a Java array.

Parameters:

array - the array to write to

offset - the offset into the array where to start writing

length - the length of data to read and write

Returns:

this

put

public LongPointer put(long[] array,
                       int offset,
                       int length)

Writes a portion of a Java array into the native array.

Parameters:

array - the array to read from

offset - the offset into the array where to start reading

length - the length of data to read and write

Returns:

this

asBuffer

public final LongBuffer asBuffer()

Description copied from class: Pointer

Same as Pointer.asByteBuffer(), but can be overridden to return subclasses of Buffer.

Overrides:

asBuffer in class Pointer

Returns:

asByteBuffer().asLongBuffer()

See Also:

BytePointer.asBuffer(), ShortPointer.asBuffer(), IntPointer.asBuffer(), asBuffer(), FloatPointer.asBuffer(), DoublePointer.asBuffer(), CharPointer.asBuffer()