FloatBufferpublic abstract class FloatBuffer extends Buffer implements Comparable| A float buffer.
This class is provided as part of the JSR 239 NIO Buffer
building block. It is a subset of the
java.nio.FloatBuffer class in Java(TM) Standard Edition
version 1.4.2. Differences are noted in bold italic.
The class documentation may make reference to classes that are not
present in the building block.
I/O channels, marking and resetting, and read-only buffers
are not supported. Allocation of non-direct float buffers,
compaction, and duplication are not supported.
The following methods are omitted:
FloatBuffer allocate(int capacity)FloatBuffer compact()FloatBuffer duplicate()Buffer mark()Buffer reset()boolean isReadOnly()FloatBuffer asReadOnlyBuffer()
This class defines four categories of operations upon
float buffers:
Absolute and relative {@link #get() get} and
{@link #put(float) put} methods that read and write
single floats; Relative {@link #get(float[]) bulk get}
methods that transfer contiguous sequences of floats from this buffer
into an array; Relative {@link #put(float[]) 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 {@link #slice
slicing} a float buffer. JSR 239 does
not support compacting and duplicating buffers.
Float buffers can be created either by allocation, which
allocates space for the buffer's content, by {@link #wrap(float[])
wrapping} an existing float array into a
buffer, or by creating a view of an existing byte
buffer. JSR 239 supports allocation of
ByteBuffers only.
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 {@link
#isDirect 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. |
| Fields Summary |
|---|
| ByteBufferImpl | parent | | float[] | array | | int | arrayOffset | | boolean | isDirect | | boolean | disposed |
| Constructors Summary |
|---|
FloatBuffer()Constructs a new FloatBuffer.
|
| Methods Summary |
|---|
| public final float[] | 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 {@link #hasArray hasArray} method before
invoking this method in order to ensure that this buffer has an
accessible backing array.
if (array == null) {
throw new UnsupportedOperationException();
}
return array;
| | public final int | 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 {@link #hasArray hasArray} method before
invoking this method in order to ensure that this buffer has an
accessible backing array.
if (array == null) {
throw new UnsupportedOperationException();
}
return arrayOffset;
| | public int | compareTo(java.lang.Object ob)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.
A float buffer is not comparable to any other type of object.
FloatBuffer that = (FloatBuffer)ob;
int n = this.position() + Math.min(this.remaining(), that.remaining());
for (int i = this.position(), j = that.position(); i < n; i++, j++) {
float v1 = this.get(i);
float v2 = that.get(j);
if (v1 == v2)
continue;
if ((v1 != v1) && (v2 != v2)) // For float and double
continue;
if (v1 < v2)
return -1;
return +1;
}
return this.remaining() - that.remaining();
| | public boolean | equals(java.lang.Object 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.
A float buffer is not equal to any other type of object.
if (!(ob instanceof FloatBuffer))
return false;
FloatBuffer that = (FloatBuffer)ob;
if (this.remaining() != that.remaining())
return false;
int p = this.position();
for (int i = this.limit() - 1, j = that.limit() - 1; i >= p; i--, j--) {
float v1 = this.get(i);
float v2 = that.get(j);
if (v1 != v2) {
if ((v1 != v1) && (v2 != v2)) // For float and double
continue;
return false;
}
}
return true;
| | public java.nio.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)
return get(dst, 0, dst.length);
| | public abstract float | get()Relative get method. Reads the float at this
buffer's current position, and then increments the
position.
| | public abstract float | get(int index)Absolute get method. Reads the float at the given
index.
| | public java.nio.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 {@link
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.
if (offset < 0 || offset > dst.length ||
length < 0 || length > dst.length - offset) {
throw new IndexOutOfBoundsException();
}
if (limit - position < length) {
throw new BufferUnderflowException();
}
int bytePtr = arrayOffset + (position << 2);
if (isDirect) {
ByteBufferImpl._getFloats(bytePtr, dst, offset, length);
} else if (array != null) {
System.arraycopy(array, arrayOffset + position,
dst, offset, length);
} else {
for (int i = 0; i < length; i++) {
dst[offset++] = parent.getFloat(bytePtr);
bytePtr += 4;
}
}
position += length;
return this;
| | public final boolean | hasArray()Tells whether or not this buffer is backed by an accessible
float array.
If this method returns true then the {@link
#array() array} and {@link #arrayOffset() arrayOffset} methods
may safely be invoked.
return array != null;
| | public int | 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.
int h = 1;
int p = position();
for (int i = limit() - 1; i >= p; i--)
h = 31 * h + (int)get(i);
return h;
| | public abstract boolean | isDirect()Tells whether or not this float buffer is direct.
| | public java.nio.FloatBuffer | put(java.nio.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 {@link
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 (src == this) {
throw new IllegalArgumentException();
}
FloatBufferImpl srci = (FloatBufferImpl)src;
int length = srci.limit - srci.position;
if (length > this.limit - this.position) {
throw new BufferOverflowException();
}
if (isDirect && srci.isDirect) {
ByteBufferImpl._copyBytes(srci.arrayOffset +
(srci.position << 2),
this.arrayOffset +
(this.position << 2),
(length << 2));
} else if (isDirect && !srci.isDirect) {
if (array != null) {
ByteBufferImpl._putFloats(this.arrayOffset +
(this.position << 2),
srci.array,
srci.arrayOffset +
srci.position,
length);
} else {
byte[] srcArray = srci.parent.array;
int srciArrayOffset = srci.parent.arrayOffset +
srci.arrayOffset +
(srci.position << 2);
ByteBufferImpl._putBytes(this.arrayOffset +
(this.position << 2),
srcArray,
srciArrayOffset,
4*length);
}
} else if (!isDirect && srci.isDirect) {
if (array != null) {
ByteBufferImpl._getFloats(srci.arrayOffset +
(srci.position << 2),
this.array,
this.arrayOffset + this.position,
length);
} else {
byte[] dstArray = parent.array;
int dstArrayOffset = parent.arrayOffset +
arrayOffset +
(position << 2);
ByteBufferImpl._getBytes(srci.arrayOffset +
(srci.position << 2),
dstArray,
dstArrayOffset,
4*length);
}
} else if (!isDirect && !srci.isDirect) {
if (array != null && srci.array != null) {
System.arraycopy(srci.array, srci.arrayOffset + srci.position,
this.array, this.arrayOffset + this.position,
length);
} else {
for (int i = 0; i < length; i++) {
put(i, srci.get(i));
}
}
}
srci.position += length;
this.position += length;
return this;
| | public java.nio.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 {@link
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.
if (offset < 0 || offset > src.length ||
length < 0 || length > src.length - offset) {
throw new IndexOutOfBoundsException();
}
if (length > limit - position) {
throw new BufferOverflowException();
}
int bytePtr = arrayOffset + (position << 2);
if (isDirect) {
ByteBufferImpl._putFloats(bytePtr, src, offset, length);
} else if (array != null) {
System.arraycopy(src, offset,
array, arrayOffset + position, length);
} else {
for (int i = 0; i < length; i++) {
parent.putFloat(bytePtr, src[offset++]);
bytePtr += 4;
}
}
position += length;
return this;
| | public final java.nio.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)
return put(src, 0, src.length);
| | public abstract java.nio.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.
| | public abstract java.nio.FloatBuffer | put(int index, float f)Absolute put method (optional operation).
Writes the given float into this buffer at the given
index.
| | public abstract java.nio.FloatBuffer | 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. JSR
239 does not support the mark.
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. JSR
239 does not support the mark or read-only buffers.
| | public java.lang.String | toString()Returns a string summarizing the state of this buffer.
return "java.nio.ShortBuffer[" +
"pos=" + position() +
"lim=" + limit() +
"cap=" + capacity() +
"]";
| | public static java.nio.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, and its mark will be undefined. Its
{@link #array backing array} will be the given array, and
its {@link #arrayOffset array offset} will be zero.
if (offset < 0 || offset > array.length ||
length < 0 || length > array.length - offset) {
throw new IndexOutOfBoundsException();
}
FloatBufferImpl fbi =
new FloatBufferImpl(null, array.length, array, 0, false);
fbi.position(offset);
fbi.limit(offset + length);
return fbi;
| | public static java.nio.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, and its mark will be
undefined. Its {@link #array backing array} will be the
given array, and its {@link #arrayOffset array offset} will
be zero.
return wrap(array, 0, array.length);
|
|
