jdk.nio.FloatBuffer
A float buffer.
This class defines four categories of operations upon float buffers:
Absolute and relative get and put methods that read and write single floats;
Relative bulk get methods that transfer contiguous sequences of floats from this buffer into an array; and
Relative bulk put methods that transfer contiguous sequences of floats from a float array or some other float buffer into this buffer; and
Methods for compacting, duplicating, and slicing a float buffer.
Float buffers can be created either by allocation, which allocates space for the buffer's
content, by wrapping an existing float array into a buffer, or by creating a view of an existing byte buffer.
Like a byte buffer, a float buffer is either direct or non-direct. A float buffer created via the wrap methods of this class will be non-direct. A float buffer created as a view of a byte buffer will be direct if, and only if, the byte buffer itself is direct. Whether or not a float buffer is direct may be determined by invoking the isDirect method.
Methods in this class that do not otherwise have a value to return are specified to return the buffer upon which they are invoked. This allows method invocations to be chained.
A float buffer. This class defines four categories of operations upon float buffers: Absolute and relative get and put methods that read and write single floats; Relative bulk get methods that transfer contiguous sequences of floats from this buffer into an array; and Relative bulk put methods that transfer contiguous sequences of floats from a float array or some other float buffer into this buffer; and Methods for compacting, duplicating, and slicing a float buffer. Float buffers can be created either by allocation, which allocates space for the buffer's content, by wrapping an existing float array into a buffer, or by creating a view of an existing byte buffer. Like a byte buffer, a float buffer is either direct or non-direct. A float buffer created via the wrap methods of this class will be non-direct. A float buffer created as a view of a byte buffer will be direct if, and only if, the byte buffer itself is direct. Whether or not a float buffer is direct may be determined by invoking the isDirect method. Methods in this class that do not otherwise have a value to return are specified to return the buffer upon which they are invoked. This allows method invocations to be chained.
*allocateclj
(*allocate 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, and each of its elements will be initialized to zero. It will have a backing array, and its array offset will be zero.
capacity - The new buffer's capacity, in floats - int
returns: The new float buffer - java.nio.FloatBuffer
throws: java.lang.IllegalArgumentException - If the capacity is a negative integer
Allocates a new float buffer. The new buffer's position will be zero, its limit will be its capacity, its mark will be undefined, and each of its elements will be initialized to zero. It will have a backing array, and its array offset will be zero. capacity - The new buffer's capacity, in floats - `int` returns: The new float buffer - `java.nio.FloatBuffer` throws: java.lang.IllegalArgumentException - If the capacity is a negative integer
*wrapclj
(*wrap array)(*wrap array offset 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, and its mark will be undefined. Its backing array will be the given array, and its array offset will be zero.
array - The array that will back the new buffer - float[]
offset - 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. - int
length - 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. - int
returns: The new float buffer - java.nio.FloatBuffer
throws: java.lang.IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold
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, and its mark will be undefined. Its backing array will be the given array, and its array offset will be zero. array - The array that will back the new buffer - `float[]` offset - 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. - `int` length - 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. - `int` returns: The new float buffer - `java.nio.FloatBuffer` throws: java.lang.IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold
arrayclj
(array this)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: The array that backs this buffer - float[]
throws: java.nio.ReadOnlyBufferException - If this buffer is backed by an array but is read-only
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: The array that backs this buffer - `float[]` throws: java.nio.ReadOnlyBufferException - If this buffer is backed by an array but is read-only
array-offsetclj
(array-offset this)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: The offset within this buffer's array
of the first element of the buffer - int
throws: java.nio.ReadOnlyBufferException - If this buffer is backed by an array but is read-only
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: The offset within this buffer's array
of the first element of the buffer - `int`
throws: java.nio.ReadOnlyBufferException - If this buffer is backed by an array but is read-onlyas-read-only-bufferclj
(as-read-only-buffer this)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, and mark values 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: The new, read-only float buffer - java.nio.FloatBuffer
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, and mark values 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: The new, read-only float buffer - `java.nio.FloatBuffer`
compactclj
(compact this)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: This buffer - java.nio.FloatBuffer
throws: java.nio.ReadOnlyBufferException - If this buffer is read-only
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: This buffer - `java.nio.FloatBuffer` throws: java.nio.ReadOnlyBufferException - If this buffer is read-only
compare-toclj
(compare-to this that)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.
that - the object to be compared. - java.nio.FloatBuffer
returns: A negative integer, zero, or a positive integer as this buffer
is less than, equal to, or greater than the given buffer - int
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.
that - the object to be compared. - `java.nio.FloatBuffer`
returns: A negative integer, zero, or a positive integer as this buffer
is less than, equal to, or greater than the given buffer - `int`direct?clj
(direct? this)Tells whether or not this float buffer is direct.
returns: true if, and only if, this buffer is direct - boolean
Tells whether or not this float buffer is direct. returns: true if, and only if, this buffer is direct - `boolean`
duplicateclj
(duplicate this)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, and mark values 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: The new float buffer - java.nio.FloatBuffer
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, and mark values 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: The new float buffer - `java.nio.FloatBuffer`
equalsclj
(equals this ob)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.
ob - The object to which this buffer is to be compared - java.lang.Object
returns: true if, and only if, this buffer is equal to the
given object - boolean
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.
ob - The object to which this buffer is to be compared - `java.lang.Object`
returns: true if, and only if, this buffer is equal to the
given object - `boolean`getclj
(get this)(get this index)(get this dst offset 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.
dst - The array into which floats are to be written - float[]
offset - The offset within the array of the first float to be written; must be non-negative and no larger than dst.length - int
length - The maximum number of floats to be written to the given array; must be non-negative and no larger than dst.length - offset - int
returns: This buffer - java.nio.FloatBuffer
throws: java.nio.BufferUnderflowException - If there are fewer than length floats remaining in this buffer
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.
dst - The array into which floats are to be written - `float[]`
offset - The offset within the array of the first float to be written; must be non-negative and no larger than dst.length - `int`
length - The maximum number of floats to be written to the given array; must be non-negative and no larger than dst.length - offset - `int`
returns: This buffer - `java.nio.FloatBuffer`
throws: java.nio.BufferUnderflowException - If there are fewer than length floats remaining in this bufferhas-array?clj
(has-array? this)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: true if, and only if, this buffer
is backed by an array and is not read-only - boolean
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: true if, and only if, this buffer
is backed by an array and is not read-only - `boolean`hash-codeclj
(hash-code this)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: The current hash code of this buffer - int
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: The current hash code of this buffer - `int`
orderclj
(order this)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: This buffer's byte order - java.nio.ByteOrder
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: This buffer's byte order - `java.nio.ByteOrder`
putclj
(put this f)(put this index f)(put this src offset 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(a[i]);
except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
src - The array from which floats are to be read - float[]
offset - The offset within the array of the first float to be read; must be non-negative and no larger than array.length - int
length - The number of floats to be read from the given array; must be non-negative and no larger than array.length - offset - int
returns: This buffer - java.nio.FloatBuffer
throws: java.nio.BufferOverflowException - If there is insufficient space in this buffer
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(a[i]);
except that it first checks that there is sufficient space in this
buffer and it is potentially much more efficient.
src - The array from which floats are to be read - `float[]`
offset - The offset within the array of the first float to be read; must be non-negative and no larger than array.length - `int`
length - The number of floats to be read from the given array; must be non-negative and no larger than array.length - offset - `int`
returns: This buffer - `java.nio.FloatBuffer`
throws: java.nio.BufferOverflowException - If there is insufficient space in this buffersliceclj
(slice this)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, and its mark will be undefined. 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: The new float buffer - java.nio.FloatBuffer
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, and its mark will be undefined. 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: The new float buffer - `java.nio.FloatBuffer`
to-stringclj
(to-string this)Returns a string summarizing the state of this buffer.
returns: A summary string - java.lang.String
Returns a string summarizing the state of this buffer. returns: A summary string - `java.lang.String`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close