public static DoubleBuffer allocate​(int capacity)

Allocates a new double 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.

public static DoubleBuffer wrap​(double[] array,
                                int offset,
                                int length)

Wraps a double array into a buffer.

The new buffer will be backed by the given double 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.

public static DoubleBuffer wrap​(double[] array)

Wraps a double array into a buffer.

The new buffer will be backed by the given double 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.

public abstract DoubleBuffer slice()

Creates a new double 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 doubles 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.

public abstract DoubleBuffer duplicate()

Creates a new double 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.

public abstract DoubleBuffer asReadOnlyBuffer()

Creates a new, read-only double 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.

public abstract double get()

public abstract DoubleBuffer put​(double d)

Relative put method (optional operation).

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

public abstract double get​(int index)

public abstract DoubleBuffer put​(int index,
                                 double d)

Absolute put method (optional operation).

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

public DoubleBuffer get​(double[] dst,
                        int offset,
                        int length)

Relative bulk get method.

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

Otherwise, this method copies length doubles 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 doubles in this buffer and it is potentially much more efficient.

public DoubleBuffer get​(double[] dst)

Relative bulk get method.

This method transfers doubles 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)

public DoubleBuffer put​(DoubleBuffer src)

Relative bulk put method (optional operation).

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

Otherwise, this method copies n = src.remaining() doubles 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.

public DoubleBuffer put​(double[] src,
                        int offset,
                        int length)

Relative bulk put method (optional operation).

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

Otherwise, this method copies length doubles 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.

public final DoubleBuffer put​(double[] src)

Relative bulk put method (optional operation).

This method transfers the entire content of the given source double 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)

public final boolean hasArray()

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

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

public final double[] array()

Returns the double 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.

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 hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.

public abstract DoubleBuffer compact()

Compacts this buffer (optional operation).

The doubles between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the double at index p = position() is copied to index zero, the double at index p + 1 is copied to index one, and so forth until the double 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 doubles copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.

public abstract boolean isDirect()

public String toString()

public int hashCode()

Returns the current hash code of this buffer.

The hash code of a double 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.

public boolean equals​(Object ob)

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

Two double buffers are equal if, and only if,

1. They have the same element type,

2. They have the same number of remaining elements, and

3. The two sequences of remaining elements, considered independently of their starting positions, are pointwise equal. This method considers two double elements a and b to be equal if (a == b) || (Double.isNaN(a) && Double.isNaN(b)). The values -0.0 and +0.0 are considered to be equal, unlike Double.equals(Object).

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

public int compareTo​(DoubleBuffer that)

Compares this buffer to another.

Two double 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 double elements are compared as if by invoking Double.compare(double,double), except that -0.0 and 0.0 are considered to be equal. Double.NaN is considered by this method to be equal to itself and greater than all other double values (including Double.POSITIVE_INFINITY).

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

public int mismatch​(DoubleBuffer 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.

public abstract ByteOrder order()

Retrieves this buffer's byte order.

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