org.bytedeco.javacpp

Class FloatPointer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.FloatPointer

public class FloatPointer
extends Pointer

The peer class to native pointers and arrays of float. 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.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
private void	allocateArray(int size)
FloatBuffer	asBuffer() Same as Pointer.asByteBuffer(), but can be overridden to return subclasses of Buffer.
FloatPointer	capacity(int capacity) Sets the capacity and returns this.
float	get()
FloatPointer	get(float[] array)
FloatPointer	get(float[] array, int offset, int length) Reads a portion of the native array into a Java array.
float	get(int i)
FloatPointer	limit(int limit) Sets the limit and returns this.
FloatPointer	position(int position) Sets the position and returns this.
FloatPointer	put(float... array)
FloatPointer	put(float f)
FloatPointer	put(float[] array, int offset, int length) Writes a portion of a Java array into the native array.
FloatPointer	put(int i, float f) Copies the float value to the i-th element of a native array.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asByteBuffer, capacity, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, hashCode, init, isNull, limit, memchr, memcmp, memcpy, memmove, memset, offsetof, position, put, setNull, sizeof, toString, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatPointer

public FloatPointer(float... array)

Allocates enough memory for the array and copies it.

Parameters:

array - the array to copy

See Also:

put(float[])

FloatPointer

public FloatPointer(FloatBuffer buffer)

For direct buffers, calls Pointer.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(float[])

FloatPointer

public FloatPointer(int size)

Allocates a native float array of the given size.

Parameters:

size - the number of float elements to allocate

FloatPointer

public FloatPointer()

See Also:

Pointer.Pointer()

FloatPointer

public FloatPointer(Pointer p)

See Also:

Pointer.Pointer(Pointer)

Method Detail

allocateArray

private void allocateArray(int size)

position

public FloatPointer position(int 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(int)

limit

public FloatPointer limit(int 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.position(int)

capacity

public FloatPointer capacity(int 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(int)

get

public float get()

Returns:

get(0)

get

public float get(int i)

Returns:

the i-th float value of a native array

put

public FloatPointer put(float f)

Returns:

put(0, f)

put

public FloatPointer put(int i,
               float f)

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

Parameters:

i - the index into the array

f - the float value to copy

Returns:

this

get

public FloatPointer get(float[] array)

Returns:

get(array, 0, array.length)

put

public FloatPointer put(float... array)

Returns:

put(array, 0, array.length)

get

public FloatPointer get(float[] 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 FloatPointer put(float[] 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 FloatBuffer 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().asFloatBuffer()

See Also:

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