OpenJDK 27 · java.nio.FloatBuffer · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final long	ARRAY_BASE_OFFSET
pack-priv final float[]	hb
pack-priv boolean	isReadOnly
pack-priv final int	offset

Access	Constructor and Description
pack-priv	FloatBuffer(int mark, int pos, int lim, int cap, float[] hb, int offset, MemorySegment segment)
pack-priv	FloatBuffer(int mark, int pos, int lim, int cap, MemorySegment segment)
pack-priv	FloatBuffer(float[] hb, long addr, int cap, MemorySegment segment)

Method Summary

Modifier and Type	Method and Description
public static FloatBuffer	Returns: The new float buffer allocate(int The new buffer's capacity, in floats capacity) Allocates a new float buffer.
public final float[]	Returns: The array that backs this buffer array() Implements abstract java.nio.Buffer.array. Returns the float array that backs this buffer (optional operation).
public final int	Returns: The offset within this buffer's array of the first element of the buffer arrayOffset() Implements abstract java.nio.Buffer.arrayOffset. Returns the offset within this buffer's backing array of the first element of the buffer (optional operation).
public abstract FloatBuffer	Returns: The new, read-only float buffer asReadOnlyBuffer() Creates a new, read-only float buffer that shares this buffer's content.
pack-priv Object	base() Implements abstract java.nio.Buffer.base.
public final FloatBuffer	clear() Overrides java.nio.Buffer.clear. Clears this buffer.
public abstract FloatBuffer	Returns: This buffer compact() Compacts this buffer (optional operation).
private static int	compare(float x, float y)
public int	Returns: A negative integer, zero, or a positive integer as this buffer is less than, equal to, or greater than the given buffer compareTo(FloatBuffer that) Implements java.lang.Comparable.compareTo. Compares this buffer to another.
public abstract FloatBuffer	Returns: The new float buffer duplicate() Implements abstract java.nio.Buffer.duplicate. Creates a new float buffer that shares this buffer's content.
public boolean	Returns: `true` if, and only if, this buffer is equal to the given object equals(Object The object to which this buffer is to be compared ob) Overrides java.lang.Object.equals. Tells whether or not this buffer is equal to another object.
public final FloatBuffer	flip() Overrides java.nio.Buffer.flip. Flips this buffer.
public abstract float	Returns: The float at the buffer's current position get() Relative get method.
public abstract float	Returns: The float at the given index get(int The index from which the float will be read index) Absolute get method.
public FloatBuffer	Returns: This buffer get(float[] The array into which floats are to be written dst, int The offset within the array of the first float to be written; must be non-negative and no larger than `dst.length` offset, int The maximum number of floats to be written to the given array; must be non-negative and no larger than `dst.length - offset` length) Relative bulk get method.
public FloatBuffer	Returns: This buffer get(float[] The destination array dst) Relative bulk get method.
public FloatBuffer	Returns: This buffer get(int The index in this buffer from which the first float will be read; must be non-negative and less than `limit()` index, float[] The destination array dst, int The offset within the array of the first float to be written; must be non-negative and less than `dst.length` offset, int The number of floats to be written to the given array; must be non-negative and no larger than the smaller of `limit() - index` and `dst.length - offset` length) Absolute bulk get method.
public FloatBuffer	Returns: This buffer get(int The index in this buffer from which the first float will be read; must be non-negative and less than `limit()` index, float[] The destination array dst) Absolute bulk get method.
pack-priv FloatBuffer	getArray(int index, float[] dst, int offset, int length)
public final boolean	Returns: `true` if, and only if, this buffer is backed by an array and is not read-only hasArray() Implements abstract java.nio.Buffer.hasArray. Tells whether or not this buffer is backed by an accessible float array.
public int	Returns: The current hash code of this buffer hashCode() Overrides java.lang.Object.hashCode. Returns the current hash code of this buffer.
pack-priv AbstractMemorySegmentImpl	heapSegment(Object base, long offset, long length, boolean readOnly, MemorySessionImpl bufferScope) Implements abstract java.nio.Buffer.heapSegment.
public abstract boolean	Returns: `true` if, and only if, this buffer is direct isDirect() Implements abstract java.nio.Buffer.isDirect. Tells whether or not this float buffer is direct.
public final FloatBuffer	limit(int newLimit) Overrides java.nio.Buffer.limit. Sets this buffer's limit.
public final FloatBuffer	mark() Overrides java.nio.Buffer.mark. Sets this buffer's mark at its position.
public int	Returns: The relative index of the first mismatch between this and the given buffer, otherwise -1 if no mismatch. mismatch(FloatBuffer The byte buffer to be tested for a mismatch with this buffer that) Finds and returns the relative index of the first mismatch between this buffer and a given buffer.
public abstract ByteOrder	Returns: This buffer's byte order order() Retrieves this buffer's byte order.
public final FloatBuffer	position(int newPosition) Overrides java.nio.Buffer.position. Sets this buffer's position.
public abstract FloatBuffer	Returns: This buffer put(float The float to be written f) Relative put method (optional operation).
public abstract FloatBuffer	Returns: This buffer put(int The index at which the float will be written index, float The float value to be written f) Absolute put method (optional operation).
public FloatBuffer	Returns: This buffer put(FloatBuffer The source buffer from which floats are to be read; must not be this buffer src) Relative bulk put method (optional operation).
public FloatBuffer	Returns: This buffer put(int The index in this buffer at which the first float will be written; must be non-negative and less than `limit()` index, FloatBuffer The buffer from which floats are to be read src, int The index within the source buffer of the first float to be read; must be non-negative and less than `src.limit()` offset, int The number of floats to be read from the given buffer; must be non-negative and no larger than the smaller of `limit() - index` and `src.limit() - offset` length) Absolute bulk put method (optional operation).
public FloatBuffer	Returns: This buffer put(float[] The array from which floats are to be read src, int The offset within the array of the first float to be read; must be non-negative and no larger than `src.length` offset, int The number of floats to be read from the given array; must be non-negative and no larger than `src.length - offset` length) Relative bulk put method (optional operation).
public final FloatBuffer	Returns: This buffer put(float[] The source array src) Relative bulk put method (optional operation).
public FloatBuffer	Returns: This buffer put(int The index in this buffer at which the first float will be written; must be non-negative and less than `limit()` index, float[] The array from which floats are to be read src, int The offset within the array of the first float to be read; must be non-negative and less than `src.length` offset, int The number of floats to be read from the given array; must be non-negative and no larger than the smaller of `limit() - index` and `src.length - offset` length) Absolute bulk put method (optional operation).
public FloatBuffer	Returns: This buffer put(int The index in this buffer at which the first float will be written; must be non-negative and less than `limit()` index, float[] The array from which floats are to be read src) Absolute bulk put method (optional operation).
pack-priv FloatBuffer	putArray(int index, float[] src, int offset, int length)
pack-priv void	putBuffer(int pos, FloatBuffer src, int srcPos, int n)
public final FloatBuffer	reset() Overrides java.nio.Buffer.reset. Resets this buffer's position to the previously-marked position.
public final FloatBuffer	rewind() Overrides java.nio.Buffer.rewind. Rewinds this buffer.
pack-priv int	scaleShifts() Implements abstract java.nio.Buffer.scaleShifts. Returns the scale shifts for this Buffer.
public abstract FloatBuffer	Returns: The new float buffer slice() Implements abstract java.nio.Buffer.slice. Creates a new float buffer whose content is a shared subsequence of this buffer's content.
public abstract FloatBuffer	Returns: The new buffer slice(int The position in this buffer at which the content of the new buffer will start; must be non-negative and no larger than `limit()` index, int The number of elements the new buffer will contain; must be non-negative and no larger than `limit() - index` length) Implements abstract java.nio.Buffer.slice. Creates a new float buffer whose content is a shared subsequence of this buffer's content.
public String	Returns: A summary string toString() Overrides java.lang.Object.toString. Returns a string summarizing the state of this buffer.
public static FloatBuffer	Returns: The new float buffer wrap(float[] The array that will back the new buffer array, int The offset of the subarray to be used; must be non-negative and no larger than `array.length`. The new buffer's position will be set to this value. offset, int The length of the subarray to be used; must be non-negative and no larger than `array.length - offset`. The new buffer's limit will be set to `offset + length`. length) Wraps a float array into a buffer.
public static FloatBuffer	Returns: The new float buffer wrap(float[] The array that will back this buffer array) Wraps a float array into a buffer.

Inherited from java.nio.Buffer:: capacity checkIndex checkIndex checkSession createCapacityException createSameBufferException discardMark hasRemaining isReadOnly limit markValue nextGetIndex nextGetIndex nextPutIndex nextPutIndex position remaining session

ARRAY_BASE_OFFSET	back to summary
private static final long ARRAY_BASE_OFFSET

hb	back to summary
pack-priv final float[] hb

isReadOnly	back to summary
pack-priv boolean isReadOnly

offset	back to summary
pack-priv final int offset

FloatBuffer	back to summary
pack-priv FloatBuffer(int mark, int pos, int lim, int cap, float[] hb, int offset, MemorySegment segment)

FloatBuffer	back to summary
pack-priv FloatBuffer(int mark, int pos, int lim, int cap, MemorySegment segment)

FloatBuffer	back to summary
pack-priv FloatBuffer(float[] hb, long addr, int cap, MemorySegment segment)

Method Detail

allocate back to summary

allocate	back to summary
public static FloatBuffer allocate(int capacity) Allocates a new float buffer. The new buffer's position will be zero, its limit will be its capacity, its mark will be undefined, each of its elements will be initialized to zero, and its byte order will be the `native order` of the underlying hardware. It will have a `backing array`, and its `array offset` will be zero. Parameters capacity:int The new buffer's capacity, in floats Returns:FloatBuffer The new float buffer Exceptions IllegalArgumentException: If the `capacity` is a negative integer

public static FloatBuffer allocate(int capacity)

Allocates a new float buffer.

The new buffer's position will be zero, its limit will be its capacity, its mark will be undefined, each of its elements will be initialized to zero, and its byte order will be the native order of the underlying hardware. It will have a backing array, and its array offset will be zero.

Parameters

capacity:int: The new buffer's capacity, in floats

Returns:FloatBuffer

The new float buffer

Exceptions

IllegalArgumentException:: If the capacity is a negative integer

array back to summary

array	back to summary
public final float[] array() Implements abstract java.nio.Buffer.array. Returns the float array that backs this buffer (optional operation). Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa. Invoke the `hasArray` method before invoking this method in order to ensure that this buffer has an accessible backing array. Returns:float[] The array that backs this buffer Exceptions ReadOnlyBufferException: If this buffer is backed by an array but is read-only UnsupportedOperationException: If this buffer is not backed by an accessible array

public final float[] array()

Implements abstract java.nio.Buffer.array.

Returns the float array that backs this buffer (optional operation).

Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa.

Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.

Returns:float[]

The array that backs this buffer

Exceptions

ReadOnlyBufferException:: If this buffer is backed by an array but is read-only
UnsupportedOperationException:: If this buffer is not backed by an accessible array

arrayOffset back to summary

arrayOffset	back to summary
public final int arrayOffset() Implements abstract java.nio.Buffer.arrayOffset. Returns the offset within this buffer's backing array of the first element of the buffer (optional operation). If this buffer is backed by an array then buffer position p corresponds to array index p + `arrayOffset()`. Invoke the `hasArray` method before invoking this method in order to ensure that this buffer has an accessible backing array. Returns:int The offset within this buffer's array of the first element of the buffer Exceptions ReadOnlyBufferException: If this buffer is backed by an array but is read-only UnsupportedOperationException: If this buffer is not backed by an accessible array

public final int arrayOffset()

Implements abstract java.nio.Buffer.arrayOffset.

Returns the offset within this buffer's backing array of the first element of the buffer (optional operation).

If this buffer is backed by an array then buffer position p corresponds to array index p + arrayOffset().

Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.

Returns:int

The offset within this buffer's array of the first element of the buffer

Exceptions

ReadOnlyBufferException:: If this buffer is backed by an array but is read-only
UnsupportedOperationException:: If this buffer is not backed by an accessible array

asReadOnlyBuffer back to summary

asReadOnlyBuffer	back to summary
public abstract FloatBuffer asReadOnlyBuffer() Creates a new, read-only float buffer that shares this buffer's content. The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffers' position, limit, and mark values will be independent. The new buffer's capacity, limit, position, mark values, and byte order will be identical to those of this buffer. If this buffer is itself read-only then this method behaves in exactly the same way as the `duplicate` method. Returns:FloatBuffer The new, read-only float buffer

public abstract FloatBuffer asReadOnlyBuffer()

Creates a new, read-only float buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, mark values, and byte order will be identical to those of this buffer.

If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate method.

Returns:FloatBuffer: The new, read-only float buffer

base	back to summary
pack-priv Object base() Implements abstract java.nio.Buffer.base. Annotations @Override

base

back to summary

pack-priv Object base()

Implements abstract java.nio.Buffer.base.

Annotations

@Override

clear back to summary

clear	back to summary
public final FloatBuffer clear() Overrides java.nio.Buffer.clear. Doc from java.nio.Buffer.clear. Clears this buffer. The position is set to zero, the limit is set to the capacity, and the mark is discarded. Invoke this method before using a sequence of channel-read or put operations to fill this buffer. For example: `buf.clear(); // Prepare buffer for reading in.read(buf); // Read data` buf.clear(); // Prepare buffer for reading in.read(buf); // Read data This method does not actually erase the data in the buffer, but it is named as if it did because it will most often be used in situations in which that might as well be the case. Annotations @Override Since 9

public final FloatBuffer clear()

Overrides java.nio.Buffer.clear.

Doc from java.nio.Buffer.clear.

Clears this buffer. The position is set to zero, the limit is set to the capacity, and the mark is discarded.

Invoke this method before using a sequence of channel-read or put operations to fill this buffer. For example:

buf.clear();     // Prepare buffer for reading
in.read(buf);    // Read data

This method does not actually erase the data in the buffer, but it is named as if it did because it will most often be used in situations in which that might as well be the case.

Annotations

@Override

Since

compact back to summary

compact	back to summary
public abstract FloatBuffer compact() Compacts this buffer (optional operation). The floats between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the float at index p = `position()` is copied to index zero, the float at index p + 1 is copied to index one, and so forth until the float at index `limit()` - 1 is copied to index n = `limit()` - `1` - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded. The buffer's position is set to the number of floats copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method. Returns:FloatBuffer This buffer Exceptions ReadOnlyBufferException: If this buffer is read-only

public abstract FloatBuffer compact()

Compacts this buffer (optional operation).

The floats between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the float at index p = position() is copied to index zero, the float at index p + 1 is copied to index one, and so forth until the float at index limit() - 1 is copied to index n = limit() - 1 - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.

The buffer's position is set to the number of floats copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.

Returns:FloatBuffer

This buffer

Exceptions

ReadOnlyBufferException:: If this buffer is read-only

compare	back to summary
private static int compare(float x, float y)

compareTo back to summary

compareTo	back to summary
public int compareTo(FloatBuffer that) Implements java.lang.Comparable.compareTo. Compares this buffer to another. Two float buffers are compared by comparing their sequences of remaining elements lexicographically, without regard to the starting position of each sequence within its corresponding buffer. Pairs of `float` elements are compared as if by invoking `Float#compare(float, float)`, except that `-0.0` and `0.0` are considered to be equal. `Float.NaN` is considered by this method to be equal to itself and greater than all other `float` values (including `Float.POSITIVE_INFINITY`). A float buffer is not comparable to any other type of object. Returns:int A negative integer, zero, or a positive integer as this buffer is less than, equal to, or greater than the given buffer

public int compareTo(FloatBuffer that)

Implements java.lang.Comparable.compareTo.

Compares this buffer to another.

Two float buffers are compared by comparing their sequences of remaining elements lexicographically, without regard to the starting position of each sequence within its corresponding buffer. Pairs of float elements are compared as if by invoking Float#compare(float, float), except that -0.0 and 0.0 are considered to be equal. Float.NaN is considered by this method to be equal to itself and greater than all other float values (including Float.POSITIVE_INFINITY).

A float buffer is not comparable to any other type of object.

Returns:int: A negative integer, zero, or a positive integer as this buffer is less than, equal to, or greater than the given buffer

duplicate	back to summary
public abstract FloatBuffer duplicate() Implements abstract java.nio.Buffer.duplicate. Creates a new float buffer that shares this buffer's content. The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent. The new buffer's capacity, limit, position, mark values, and byte order will be identical to those of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only. Returns:FloatBuffer The new float buffer Annotations @Override

duplicate

back to summary

public abstract FloatBuffer duplicate()

Implements abstract java.nio.Buffer.duplicate.

Creates a new float buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, mark values, and byte order will be identical to those of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Returns:FloatBuffer

The new float buffer

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object ob) Overrides java.lang.Object.equals. Tells whether or not this buffer is equal to another object. Two float buffers are equal if, and only if, They have the same element type, They have the same number of remaining elements, and The two sequences of remaining elements, considered independently of their starting positions, are pointwise equal. This method considers two float elements `a` and `b` to be equal if `(a == b) \|\| (Float.isNaN(a) && Float.isNaN(b))`. The values `-0.0` and `+0.0` are considered to be equal, unlike `Float#equals(Object)`. A float buffer is not equal to any other type of object. Parameters ob:Object The object to which this buffer is to be compared Returns:boolean `true` if, and only if, this buffer is equal to the given object

public boolean equals(Object ob)

Overrides java.lang.Object.equals.

Tells whether or not this buffer is equal to another object.

Two float buffers are equal if, and only if,

They have the same element type,
They have the same number of remaining elements, and
The two sequences of remaining elements, considered independently of their starting positions, are pointwise equal. This method considers two float elements a and b to be equal if (a == b) || (Float.isNaN(a) && Float.isNaN(b)). The values -0.0 and +0.0 are considered to be equal, unlike Float#equals(Object).

A float buffer is not equal to any other type of object.

Parameters

ob:Object: The object to which this buffer is to be compared

Returns:boolean

true if, and only if, this buffer is equal to the given object

flip back to summary

flip	back to summary
public final FloatBuffer flip() Overrides java.nio.Buffer.flip. Doc from java.nio.Buffer.flip. Flips this buffer. The limit is set to the current position and then the position is set to zero. If the mark is defined then it is discarded. After a sequence of channel-read or put operations, invoke this method to prepare for a sequence of channel-write or relative get operations. For example: `buf.put(magic); // Prepend header in.read(buf); // Read data into rest of buffer buf.flip(); // Flip buffer out.write(buf); // Write header + data to channel` buf.put(magic); // Prepend header in.read(buf); // Read data into rest of buffer buf.flip(); // Flip buffer out.write(buf); // Write header + data to channel This method is often used in conjunction with the `compact` method when transferring data from one place to another. Annotations @Override Since 9

public final FloatBuffer flip()

Overrides java.nio.Buffer.flip.

Doc from java.nio.Buffer.flip.

Flips this buffer. The limit is set to the current position and then the position is set to zero. If the mark is defined then it is discarded.

After a sequence of channel-read or put operations, invoke this method to prepare for a sequence of channel-write or relative get operations. For example:

buf.put(magic);    // Prepend header
in.read(buf);      // Read data into rest of buffer
buf.flip();        // Flip buffer
out.write(buf);    // Write header + data to channel

This method is often used in conjunction with the compact method when transferring data from one place to another.

Annotations

@Override

Since

get	back to summary
public abstract float get() Relative get method. Reads the float at this buffer's current position, and then increments the position. Returns:float The float at the buffer's current position Exceptions BufferUnderflowException: If the buffer's current position is not smaller than its limit

get

back to summary

public abstract float get()

Relative get method. Reads the float at this buffer's current position, and then increments the position.

Returns:float

The float at the buffer's current position

Exceptions

BufferUnderflowException:: If the buffer's current position is not smaller than its limit

get back to summary

get	back to summary
public abstract float get(int index) Absolute get method. Reads the float at the given index. Parameters index:int The index from which the float will be read Returns:float The float at the given index Exceptions IndexOutOfBoundsException: If `index` is negative or not smaller than the buffer's limit

public abstract float get(int index)

Absolute get method. Reads the float at the given index.

Parameters

index:int: The index from which the float will be read

Returns:float

The float at the given index

Exceptions

IndexOutOfBoundsException:: If index is negative or not smaller than the buffer's limit

get back to summary

get	back to summary
public FloatBuffer get(float[] dst, int offset, int length) Relative bulk get method. This method transfers floats from this buffer into the given destination array. If there are fewer floats remaining in the buffer than are required to satisfy the request, that is, if `length` `>` `remaining()`, then no floats are transferred and a `BufferUnderflowException` is thrown. Otherwise, this method copies `length` floats from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by `length`. In other words, an invocation of this method of the form `src.get(dst, off, len)` has exactly the same effect as the loop `for (int i = off; i < off + len; i++) dst[i] = src.get();` for (int i = off; i < off + len; i++) dst[i] = src.get(); except that it first checks that there are sufficient floats in this buffer and it is potentially much more efficient. Parameters dst:float[] The array into which floats are to be written offset:int The offset within the array of the first float to be written; must be non-negative and no larger than `dst.length` length:int The maximum number of floats to be written to the given array; must be non-negative and no larger than `dst.length - offset` Returns:FloatBuffer This buffer Exceptions BufferUnderflowException: If there are fewer than `length` floats remaining in this buffer IndexOutOfBoundsException: If the preconditions on the `offset` and `length` parameters do not hold

public FloatBuffer get(float[] dst, int offset, int length)

Relative bulk get method.

This method transfers floats from this buffer into the given destination array. If there are fewer floats remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no floats are transferred and a BufferUnderflowException is thrown.

Otherwise, this method copies length floats from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form src.get(dst, off, len) has exactly the same effect as the loop

for (int i = off; i < off + len; i++)
    dst[i] = src.get();

except that it first checks that there are sufficient floats in this buffer and it is potentially much more efficient.

Parameters

dst:float[]: The array into which floats are to be written
offset:int: The offset within the array of the first float to be written; must be non-negative and no larger than dst.length
length:int: The maximum number of floats to be written to the given array; must be non-negative and no larger than dst.length - offset

Returns:FloatBuffer

This buffer

Exceptions

BufferUnderflowException:: If there are fewer than length floats remaining in this buffer
IndexOutOfBoundsException:: If the preconditions on the offset and length parameters do not hold

get back to summary

get	back to summary
public FloatBuffer get(float[] dst) Relative bulk get method. This method transfers floats from this buffer into the given destination array. An invocation of this method of the form `src.get(a)` behaves in exactly the same way as the invocation `src.get(a, 0, a.length)` src.get(a, 0, a.length) Parameters dst:float[] The destination array Returns:FloatBuffer This buffer Exceptions BufferUnderflowException: If there are fewer than `length` floats remaining in this buffer

public FloatBuffer get(float[] dst)

Relative bulk get method.

This method transfers floats from this buffer into the given destination array. An invocation of this method of the form src.get(a) behaves in exactly the same way as the invocation

src.get(a, 0, a.length)

Parameters

dst:float[]: The destination array

Returns:FloatBuffer

This buffer

Exceptions

BufferUnderflowException:: If there are fewer than length floats remaining in this buffer

get back to summary

get	back to summary
public FloatBuffer get(int index, float[] dst, int offset, int length) Absolute bulk get method. This method transfers `length` floats from this buffer into the given array, starting at the given index in this buffer and at the given offset in the array. The position of this buffer is unchanged. An invocation of this method of the form `src.get(index, dst, offset, length)` has exactly the same effect as the following loop except that it first checks the consistency of the supplied parameters and it is potentially much more efficient: `for (int i = offset, j = index; i < offset + length; i++, j++) dst[i] = src.get(j);` for (int i = offset, j = index; i < offset + length; i++, j++) dst[i] = src.get(j); Parameters index:int The index in this buffer from which the first float will be read; must be non-negative and less than `limit()` dst:float[] The destination array offset:int The offset within the array of the first float to be written; must be non-negative and less than `dst.length` length:int The number of floats to be written to the given array; must be non-negative and no larger than the smaller of `limit() - index` and `dst.length - offset` Returns:FloatBuffer This buffer Exceptions IndexOutOfBoundsException: If the preconditions on the `index`, `offset`, and `length` parameters do not hold Since 13

public FloatBuffer get(int index, float[] dst, int offset, int length)

Absolute bulk get method.

This method transfers length floats from this buffer into the given array, starting at the given index in this buffer and at the given offset in the array. The position of this buffer is unchanged.

An invocation of this method of the form src.get(index, dst, offset, length) has exactly the same effect as the following loop except that it first checks the consistency of the supplied parameters and it is potentially much more efficient:

for (int i = offset, j = index; i < offset + length; i++, j++)
    dst[i] = src.get(j);

Parameters

index:int: The index in this buffer from which the first float will be read; must be non-negative and less than limit()
dst:float[]: The destination array
offset:int: The offset within the array of the first float to be written; must be non-negative and less than dst.length
length:int: The number of floats to be written to the given array; must be non-negative and no larger than the smaller of limit() - index and dst.length - offset

Returns:FloatBuffer

This buffer

Exceptions

IndexOutOfBoundsException:: If the preconditions on the index, offset, and length parameters do not hold

Since

get back to summary

get	back to summary
public FloatBuffer get(int index, float[] dst) Absolute bulk get method. This method transfers floats from this buffer into the given destination array. The position of this buffer is unchanged. An invocation of this method of the form `src.get(index, dst)` behaves in exactly the same way as the invocation: `src.get(index, dst, 0, dst.length)` src.get(index, dst, 0, dst.length) Parameters index:int The index in this buffer from which the first float will be read; must be non-negative and less than `limit()` dst:float[] The destination array Returns:FloatBuffer This buffer Exceptions IndexOutOfBoundsException: If `index` is negative, not smaller than `limit()`, or `limit() - index < dst.length` Since 13

public FloatBuffer get(int index, float[] dst)

Absolute bulk get method.

This method transfers floats from this buffer into the given destination array. The position of this buffer is unchanged. An invocation of this method of the form src.get(index, dst) behaves in exactly the same way as the invocation:

src.get(index, dst, 0, dst.length)

Parameters

index:int: The index in this buffer from which the first float will be read; must be non-negative and less than limit()
dst:float[]: The destination array

Returns:FloatBuffer

This buffer

Exceptions

IndexOutOfBoundsException:: If index is negative, not smaller than limit(), or limit() - index < dst.length

Since

getArray	back to summary
pack-priv FloatBuffer getArray(int index, float[] dst, int offset, int length)

hasArray back to summary

hasArray	back to summary
public final boolean hasArray() Implements abstract java.nio.Buffer.hasArray. Tells whether or not this buffer is backed by an accessible float array. If this method returns `true` then the `array` and `arrayOffset` methods may safely be invoked. Returns:boolean `true` if, and only if, this buffer is backed by an array and is not read-only

public final boolean hasArray()

Implements abstract java.nio.Buffer.hasArray.

Tells whether or not this buffer is backed by an accessible float array.

If this method returns true then the array and arrayOffset methods may safely be invoked.

Returns:boolean: true if, and only if, this buffer is backed by an array and is not read-only

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns the current hash code of this buffer. The hash code of a float buffer depends only upon its remaining elements; that is, upon the elements from `position()` up to, and including, the element at `limit()` - `1`. Because buffer hash codes are content-dependent, it is inadvisable to use buffers as keys in hash maps or similar data structures unless it is known that their contents will not change. Returns:int The current hash code of this buffer

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns the current hash code of this buffer.

The hash code of a float buffer depends only upon its remaining elements; that is, upon the elements from position() up to, and including, the element at limit() - 1.

Because buffer hash codes are content-dependent, it is inadvisable to use buffers as keys in hash maps or similar data structures unless it is known that their contents will not change.

Returns:int: The current hash code of this buffer

heapSegment	back to summary
pack-priv AbstractMemorySegmentImpl heapSegment(Object base, long offset, long length, boolean readOnly, MemorySessionImpl bufferScope) Implements abstract java.nio.Buffer.heapSegment. Annotations @ForceInline @Override

heapSegment

back to summary

pack-priv AbstractMemorySegmentImpl heapSegment(Object base, long offset, long length, boolean readOnly, MemorySessionImpl bufferScope)

Implements abstract java.nio.Buffer.heapSegment.

Annotations

@ForceInline
@Override

isDirect back to summary

isDirect	back to summary
public abstract boolean isDirect() Implements abstract java.nio.Buffer.isDirect. Tells whether or not this float buffer is direct. Returns:boolean `true` if, and only if, this buffer is direct

public abstract boolean isDirect()

Implements abstract java.nio.Buffer.isDirect.

Tells whether or not this float buffer is direct.

Returns:boolean: true if, and only if, this buffer is direct

limit	back to summary
public final FloatBuffer limit(int newLimit) Overrides java.nio.Buffer.limit. Doc from java.nio.Buffer.limit. Sets this buffer's limit. If the position is larger than the new limit then it is set to the new limit. If the mark is defined and larger than the new limit then it is discarded. Annotations @Override Since 9

limit

back to summary

public final FloatBuffer limit(int newLimit)

Overrides java.nio.Buffer.limit.

Doc from java.nio.Buffer.limit.

Sets this buffer's limit. If the position is larger than the new limit then it is set to the new limit. If the mark is defined and larger than the new limit then it is discarded.

Annotations

@Override

Since

mark	back to summary
public final FloatBuffer mark() Overrides java.nio.Buffer.mark. Doc from java.nio.Buffer.mark. Sets this buffer's mark at its position. Annotations @Override Since 9

mark

back to summary

public final FloatBuffer mark()

Overrides java.nio.Buffer.mark.

Doc from java.nio.Buffer.mark.

Sets this buffer's mark at its position.

Annotations

@Override

Since

mismatch back to summary

mismatch	back to summary
public int mismatch(FloatBuffer that) Finds and returns the relative index of the first mismatch between this buffer and a given buffer. The index is relative to the `position` of each buffer and will be in the range of 0 (inclusive) up to the smaller of the `remaining` elements in each buffer (exclusive). If the two buffers share a common prefix then the returned index is the length of the common prefix and it follows that there is a mismatch between the two buffers at that index within the respective buffers. If one buffer is a proper prefix of the other then the returned index is the smaller of the remaining elements in each buffer, and it follows that the index is only valid for the buffer with the larger number of remaining elements. Otherwise, there is no mismatch. Parameters that:FloatBuffer The byte buffer to be tested for a mismatch with this buffer Returns:int The relative index of the first mismatch between this and the given buffer, otherwise -1 if no mismatch. Since 11

public int mismatch(FloatBuffer that)

Finds and returns the relative index of the first mismatch between this buffer and a given buffer. The index is relative to the position of each buffer and will be in the range of 0 (inclusive) up to the smaller of the remaining elements in each buffer (exclusive).

If the two buffers share a common prefix then the returned index is the length of the common prefix and it follows that there is a mismatch between the two buffers at that index within the respective buffers. If one buffer is a proper prefix of the other then the returned index is the smaller of the remaining elements in each buffer, and it follows that the index is only valid for the buffer with the larger number of remaining elements. Otherwise, there is no mismatch.

Parameters

that:FloatBuffer: The byte buffer to be tested for a mismatch with this buffer

Returns:int

The relative index of the first mismatch between this and the given buffer, otherwise -1 if no mismatch.

Since

order back to summary

order	back to summary
public abstract ByteOrder order() Retrieves this buffer's byte order. The byte order of a float buffer created by allocation or by wrapping an existing `float` array is the `native order` of the underlying hardware. The byte order of a float buffer created as a view of a byte buffer is that of the byte buffer at the moment that the view is created. Returns:ByteOrder This buffer's byte order

public abstract ByteOrder order()

Retrieves this buffer's byte order.

The byte order of a float buffer created by allocation or by wrapping an existing float array is the native order of the underlying hardware. The byte order of a float buffer created as a view of a byte buffer is that of the byte buffer at the moment that the view is created.

Returns:ByteOrder: This buffer's byte order

position	back to summary
public final FloatBuffer position(int newPosition) Overrides java.nio.Buffer.position. Doc from java.nio.Buffer.position. Sets this buffer's position. If the mark is defined and larger than the new position then it is discarded. Annotations @Override Since 9

position

back to summary

public final FloatBuffer position(int newPosition)

Overrides java.nio.Buffer.position.

Doc from java.nio.Buffer.position.

Sets this buffer's position. If the mark is defined and larger than the new position then it is discarded.

Annotations

@Override

Since

put	back to summary
public abstract FloatBuffer put(float f) Relative put method (optional operation). Writes the given float into this buffer at the current position, and then increments the position. Parameters f:float The float to be written Returns:FloatBuffer This buffer Exceptions BufferOverflowException: If this buffer's current position is not smaller than its limit ReadOnlyBufferException: If this buffer is read-only

put

back to summary

public abstract FloatBuffer put(float f)

Relative put method (optional operation).

Writes the given float into this buffer at the current position, and then increments the position.

Parameters

f:float: The float to be written

Returns:FloatBuffer

This buffer

Exceptions

BufferOverflowException:: If this buffer's current position is not smaller than its limit
ReadOnlyBufferException:: If this buffer is read-only

put back to summary

put	back to summary
public abstract FloatBuffer put(int index, float f) Absolute put method (optional operation). Writes the given float into this buffer at the given index. Parameters index:int The index at which the float will be written f:float The float value to be written Returns:FloatBuffer This buffer Exceptions IndexOutOfBoundsException: If `index` is negative or not smaller than the buffer's limit ReadOnlyBufferException: If this buffer is read-only

public abstract FloatBuffer put(int index, float f)

Absolute put method (optional operation).

Writes the given float into this buffer at the given index.

Parameters

index:int: The index at which the float will be written
f:float: The float value to be written

Returns:FloatBuffer

This buffer

Exceptions

IndexOutOfBoundsException:: If index is negative or not smaller than the buffer's limit
ReadOnlyBufferException:: If this buffer is read-only

put back to summary

put	back to summary
public FloatBuffer put(FloatBuffer src) Relative bulk put method (optional operation). This method transfers the floats remaining in the given source buffer into this buffer. If there are more floats remaining in the source buffer than in this buffer, that is, if `src.remaining()` `>` `remaining()`, then no floats are transferred and a `BufferOverflowException` is thrown. Otherwise, this method copies n = `src.remaining()` floats from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n. In other words, an invocation of this method of the form `dst.put(src)` has exactly the same effect as the loop `while (src.hasRemaining()) dst.put(src.get());` while (src.hasRemaining()) dst.put(src.get()); except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient. If this buffer and the source buffer share the same backing array or memory, then the result will be as if the source elements were first copied to an intermediate location before being written into this buffer. Parameters src:FloatBuffer The source buffer from which floats are to be read; must not be this buffer Returns:FloatBuffer This buffer Exceptions BufferOverflowException: If there is insufficient space in this buffer for the remaining floats in the source buffer IllegalArgumentException: If the source buffer is this buffer ReadOnlyBufferException: If this buffer is read-only

public FloatBuffer put(FloatBuffer src)

Relative bulk put method (optional operation).

This method transfers the floats remaining in the given source buffer into this buffer. If there are more floats remaining in the source buffer than in this buffer, that is, if src.remaining() > remaining(), then no floats are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies n = src.remaining() floats from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.

In other words, an invocation of this method of the form dst.put(src) has exactly the same effect as the loop

while (src.hasRemaining())
    dst.put(src.get());

except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient. If this buffer and the source buffer share the same backing array or memory, then the result will be as if the source elements were first copied to an intermediate location before being written into this buffer.

Parameters

src:FloatBuffer: The source buffer from which floats are to be read; must not be this buffer

Returns:FloatBuffer

This buffer

Exceptions

BufferOverflowException:: If there is insufficient space in this buffer for the remaining floats in the source buffer
IllegalArgumentException:: If the source buffer is this buffer
ReadOnlyBufferException:: If this buffer is read-only

put back to summary

put	back to summary
public FloatBuffer put(int index, FloatBuffer src, int offset, int length) Absolute bulk put method (optional operation). This method transfers `length` floats into this buffer from the given source buffer, starting at the given `offset` in the source buffer and the given `index` in this buffer. The positions of both buffers are unchanged. In other words, an invocation of this method of the form `dst.put(index, src, offset, length)` has exactly the same effect as the loop `for (int i = offset, j = index; i < offset + length; i++, j++) dst.put(j, src.get(i));` for (int i = offset, j = index; i < offset + length; i++, j++) dst.put(j, src.get(i)); except that it first checks the consistency of the supplied parameters and it is potentially much more efficient. If this buffer and the source buffer share the same backing array or memory, then the result will be as if the source elements were first copied to an intermediate location before being written into this buffer. Parameters index:int The index in this buffer at which the first float will be written; must be non-negative and less than `limit()` src:FloatBuffer The buffer from which floats are to be read offset:int The index within the source buffer of the first float to be read; must be non-negative and less than `src.limit()` length:int The number of floats to be read from the given buffer; must be non-negative and no larger than the smaller of `limit() - index` and `src.limit() - offset` Returns:FloatBuffer This buffer Exceptions IndexOutOfBoundsException: If the preconditions on the `index`, `offset`, and `length` parameters do not hold ReadOnlyBufferException: If this buffer is read-only Since 16

public FloatBuffer put(int index, FloatBuffer src, int offset, int length)

Absolute bulk put method (optional operation).

This method transfers length floats into this buffer from the given source buffer, starting at the given offset in the source buffer and the given index in this buffer. The positions of both buffers are unchanged.

In other words, an invocation of this method of the form dst.put(index, src, offset, length) has exactly the same effect as the loop

for (int i = offset, j = index; i < offset + length; i++, j++)
    dst.put(j, src.get(i));

except that it first checks the consistency of the supplied parameters and it is potentially much more efficient. If this buffer and the source buffer share the same backing array or memory, then the result will be as if the source elements were first copied to an intermediate location before being written into this buffer.

Parameters

index:int: The index in this buffer at which the first float will be written; must be non-negative and less than limit()
src:FloatBuffer: The buffer from which floats are to be read
offset:int: The index within the source buffer of the first float to be read; must be non-negative and less than src.limit()
length:int: The number of floats to be read from the given buffer; must be non-negative and no larger than the smaller of limit() - index and src.limit() - offset

Returns:FloatBuffer

This buffer

Exceptions

IndexOutOfBoundsException:: If the preconditions on the index, offset, and length parameters do not hold
ReadOnlyBufferException:: If this buffer is read-only

Since

put back to summary

put	back to summary
public FloatBuffer put(float[] src, int offset, int length) Relative bulk put method (optional operation). This method transfers floats into this buffer from the given source array. If there are more floats to be copied from the array than remain in this buffer, that is, if `length` `>` `remaining()`, then no floats are transferred and a `BufferOverflowException` is thrown. Otherwise, this method copies `length` floats from the given array into this buffer, starting at the given offset in the array and at the current position of this buffer. The position of this buffer is then incremented by `length`. In other words, an invocation of this method of the form `dst.put(src, off, len)` has exactly the same effect as the loop `for (int i = off; i < off + len; i++) dst.put(src[i]);` for (int i = off; i < off + len; i++) dst.put(src[i]); except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient. Parameters src:float[] The array from which floats are to be read offset:int The offset within the array of the first float to be read; must be non-negative and no larger than `src.length` length:int The number of floats to be read from the given array; must be non-negative and no larger than `src.length - offset` Returns:FloatBuffer This buffer Exceptions BufferOverflowException: If there is insufficient space in this buffer IndexOutOfBoundsException: If the preconditions on the `offset` and `length` parameters do not hold ReadOnlyBufferException: If this buffer is read-only

public FloatBuffer put(float[] src, int offset, int length)

Relative bulk put method (optional operation).

This method transfers floats into this buffer from the given source array. If there are more floats to be copied from the array than remain in this buffer, that is, if length > remaining(), then no floats are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies length floats from the given array into this buffer, starting at the given offset in the array and at the current position of this buffer. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form dst.put(src, off, len) has exactly the same effect as the loop

for (int i = off; i < off + len; i++)
    dst.put(src[i]);

except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.

Parameters

src:float[]: The array from which floats are to be read
offset:int: The offset within the array of the first float to be read; must be non-negative and no larger than src.length
length:int: The number of floats to be read from the given array; must be non-negative and no larger than src.length - offset

Returns:FloatBuffer

This buffer

Exceptions

BufferOverflowException:: If there is insufficient space in this buffer
IndexOutOfBoundsException:: If the preconditions on the offset and length parameters do not hold
ReadOnlyBufferException:: If this buffer is read-only

put back to summary

put	back to summary
public final FloatBuffer put(float[] src) Relative bulk put method (optional operation). This method transfers the entire content of the given source float array into this buffer. An invocation of this method of the form `dst.put(a)` behaves in exactly the same way as the invocation `dst.put(a, 0, a.length)` dst.put(a, 0, a.length) Parameters src:float[] The source array Returns:FloatBuffer This buffer Exceptions BufferOverflowException: If there is insufficient space in this buffer ReadOnlyBufferException: If this buffer is read-only

public final FloatBuffer put(float[] src)

Relative bulk put method (optional operation).

This method transfers the entire content of the given source float array into this buffer. An invocation of this method of the form dst.put(a) behaves in exactly the same way as the invocation

dst.put(a, 0, a.length)

Parameters

src:float[]: The source array

Returns:FloatBuffer

This buffer

Exceptions

BufferOverflowException:: If there is insufficient space in this buffer
ReadOnlyBufferException:: If this buffer is read-only

put back to summary

put	back to summary
public FloatBuffer put(int index, float[] src, int offset, int length) Absolute bulk put method (optional operation). This method transfers `length` floats from the given array, starting at the given offset in the array and at the given index in this buffer. The position of this buffer is unchanged. An invocation of this method of the form `dst.put(index, src, offset, length)` has exactly the same effect as the following loop except that it first checks the consistency of the supplied parameters and it is potentially much more efficient: `for (int i = offset, j = index; i < offset + length; i++, j++) dst.put(j, src[i]);` for (int i = offset, j = index; i < offset + length; i++, j++) dst.put(j, src[i]); Parameters index:int The index in this buffer at which the first float will be written; must be non-negative and less than `limit()` src:float[] The array from which floats are to be read offset:int The offset within the array of the first float to be read; must be non-negative and less than `src.length` length:int The number of floats to be read from the given array; must be non-negative and no larger than the smaller of `limit() - index` and `src.length - offset` Returns:FloatBuffer This buffer Exceptions IndexOutOfBoundsException: If the preconditions on the `index`, `offset`, and `length` parameters do not hold ReadOnlyBufferException: If this buffer is read-only Since 13

public FloatBuffer put(int index, float[] src, int offset, int length)

Absolute bulk put method (optional operation).

This method transfers length floats from the given array, starting at the given offset in the array and at the given index in this buffer. The position of this buffer is unchanged.

An invocation of this method of the form dst.put(index, src, offset, length) has exactly the same effect as the following loop except that it first checks the consistency of the supplied parameters and it is potentially much more efficient:

for (int i = offset, j = index; i < offset + length; i++, j++)
    dst.put(j, src[i]);

Parameters

index:int: The index in this buffer at which the first float will be written; must be non-negative and less than limit()
src:float[]: The array from which floats are to be read
offset:int: The offset within the array of the first float to be read; must be non-negative and less than src.length
length:int: The number of floats to be read from the given array; must be non-negative and no larger than the smaller of limit() - index and src.length - offset

Returns:FloatBuffer

This buffer

Exceptions

IndexOutOfBoundsException:: If the preconditions on the index, offset, and length parameters do not hold
ReadOnlyBufferException:: If this buffer is read-only

Since

put back to summary

put	back to summary
public FloatBuffer put(int index, float[] src) Absolute bulk put method (optional operation). This method copies floats into this buffer from the given source array. The position of this buffer is unchanged. An invocation of this method of the form `dst.put(index, src)` behaves in exactly the same way as the invocation: `dst.put(index, src, 0, src.length);` dst.put(index, src, 0, src.length); Parameters index:int The index in this buffer at which the first float will be written; must be non-negative and less than `limit()` src:float[] The array from which floats are to be read Returns:FloatBuffer This buffer Exceptions IndexOutOfBoundsException: If `index` is negative, not smaller than `limit()`, or `limit() - index < src.length` ReadOnlyBufferException: If this buffer is read-only Since 13

public FloatBuffer put(int index, float[] src)

Absolute bulk put method (optional operation).

This method copies floats into this buffer from the given source array. The position of this buffer is unchanged. An invocation of this method of the form dst.put(index, src) behaves in exactly the same way as the invocation:

dst.put(index, src, 0, src.length);

Parameters

index:int: The index in this buffer at which the first float will be written; must be non-negative and less than limit()
src:float[]: The array from which floats are to be read

Returns:FloatBuffer

This buffer

Exceptions

IndexOutOfBoundsException:: If index is negative, not smaller than limit(), or limit() - index < src.length
ReadOnlyBufferException:: If this buffer is read-only

Since

putArray	back to summary
pack-priv FloatBuffer putArray(int index, float[] src, int offset, int length)

putBuffer	back to summary
pack-priv void putBuffer(int pos, FloatBuffer src, int srcPos, int n)

reset	back to summary
public final FloatBuffer reset() Overrides java.nio.Buffer.reset. Doc from java.nio.Buffer.reset. Resets this buffer's position to the previously-marked position. Invoking this method neither changes nor discards the mark's value. Annotations @Override Since 9

reset

back to summary

public final FloatBuffer reset()

Overrides java.nio.Buffer.reset.

Doc from java.nio.Buffer.reset.

Resets this buffer's position to the previously-marked position.

Invoking this method neither changes nor discards the mark's value.

Annotations

@Override

Since

rewind back to summary

rewind	back to summary
public final FloatBuffer rewind() Overrides java.nio.Buffer.rewind. Doc from java.nio.Buffer.rewind. Rewinds this buffer. The position is set to zero and the mark is discarded. Invoke this method before a sequence of channel-write or get operations, assuming that the limit has already been set appropriately. For example: `out.write(buf); // Write remaining data buf.rewind(); // Rewind buffer buf.get(array); // Copy data into array` out.write(buf); // Write remaining data buf.rewind(); // Rewind buffer buf.get(array); // Copy data into array Annotations @Override Since 9

public final FloatBuffer rewind()

Overrides java.nio.Buffer.rewind.

Doc from java.nio.Buffer.rewind.

Rewinds this buffer. The position is set to zero and the mark is discarded.

Invoke this method before a sequence of channel-write or get operations, assuming that the limit has already been set appropriately. For example:

out.write(buf);    // Write remaining data
buf.rewind();      // Rewind buffer
buf.get(array);    // Copy data into array

Annotations

@Override

Since

scaleShifts

back to summary

pack-priv int scaleShifts()

Implements abstract java.nio.Buffer.scaleShifts.

Doc from java.nio.Buffer.scaleShifts.

Returns the scale shifts for this Buffer.

The scale shifts are: ByteBuffer: 0 ShortBuffer, CharBuffer: 1 IntBuffer, FloatBuffer: 2 LongBuffer, DoubleBuffer: 3

Annotations

@ForceInline
@Override

slice

back to summary

public abstract FloatBuffer slice()

Implements abstract java.nio.Buffer.slice.

Creates a new float buffer whose content is a shared subsequence of this buffer's content.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of floats remaining in this buffer, its mark will be undefined, and its byte order will be identical to that of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Returns:FloatBuffer

The new float buffer

Annotations

@Override

slice back to summary

public abstract FloatBuffer slice(int index, int length)

Implements abstract java.nio.Buffer.slice.

Creates a new float buffer whose content is a shared subsequence of this buffer's content.

The content of the new buffer will start at position index in this buffer, and will contain length elements. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be length, its mark will be undefined, and its byte order will be identical to that of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Parameters

index:int: The position in this buffer at which the content of the new buffer will start; must be non-negative and no larger than limit()
length:int: The number of elements the new buffer will contain; must be non-negative and no larger than limit() - index

Returns:FloatBuffer

The new buffer

Annotations

@Override

Exceptions

IndexOutOfBoundsException:: If index is negative or greater than limit(), length is negative, or length > limit() - index

Since

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a string summarizing the state of this buffer.

Returns:String: A summary string

wrap back to summary

public static FloatBuffer wrap(float[] array, int offset, int length)

Wraps a float array into a buffer.

The new buffer will be backed by the given float array; that is, modifications to the buffer will cause the array to be modified and vice versa. The new buffer's capacity will be array.length, its position will be offset, its limit will be offset + length, its mark will be undefined, and its byte order will be the native order of the underlying hardware. Its backing array will be the given array, and its array offset will be zero.

Parameters

array:float[]: The array that will back the new buffer
offset:int: The offset of the subarray to be used; must be non-negative and no larger than array.length. The new buffer's position will be set to this value.
length:int: The length of the subarray to be used; must be non-negative and no larger than array.length - offset. The new buffer's limit will be set to offset + length.

Returns:FloatBuffer

The new float buffer

Exceptions

IndexOutOfBoundsException:: If the preconditions on the offset and length parameters do not hold

wrap back to summary

public static FloatBuffer wrap(float[] array)

Wraps a float array into a buffer.

The new buffer will be backed by the given float array; that is, modifications to the buffer will cause the array to be modified and vice versa. The new buffer's capacity and limit will be array.length, its position will be zero, its mark will be undefined, and its byte order will be the native order of the underlying hardware. Its backing array will be the given array, and its array offset will be zero.

Parameters

array:float[]: The array that will back this buffer

Returns:FloatBuffer

The new float buffer

public abstract sealed Class FloatBuffer

Optional operations

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail