java/11 : java.base/java/nio/DoubleBuffer.java

DoubleBuffer
https://openjdk.java.net/
GPLv2 + Classpath Exception
/*
 * Copyright (c) 2000, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

// -- This file was mechanically generated: Do not edit! -- //

package java.nio;










import jdk.internal.util.ArraysSupport;

A double buffer.
 This class defines four categories of operations upon
double buffers:

   Absolute and relative get and put methods that read and write single doubles; 
   Relative bulk get methods that transfer contiguous sequences of doubles from this buffer into an array; and
   Relative bulk put methods that transfer contiguous sequences of doubles from a double array or some other double buffer into this buffer; and 
   A method for compacting a double buffer. 

 Double buffers can be created either by allocation, which allocates space for the buffer's content, by wrapping an existing double array into a buffer, or by creating a view of an existing byte buffer.
 Like a byte buffer, a double buffer is either direct or non-direct. A double buffer created via the wrap methods of this class will be non-direct. A double 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 double 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.
Author: Mark Reinhold, JSR-51 Expert Group
Since: 1.4/**
 * A double buffer.
 *
 * <p> This class defines four categories of operations upon
 * double buffers:
 *
 * <ul>
 *
 *   <li><p> Absolute and relative {@link #get() <i>get</i>} and
 *   {@link #put(double) <i>put</i>} methods that read and write
 *   single doubles; </p></li>
 *
 *   <li><p> Relative {@link #get(double[]) <i>bulk get</i>}
 *   methods that transfer contiguous sequences of doubles from this buffer
 *   into an array; and</p></li>
 *
 *   <li><p> Relative {@link #put(double[]) <i>bulk put</i>}
 *   methods that transfer contiguous sequences of doubles from a
 *   double array or some other double
 *   buffer into this buffer;&#32;and </p></li>
 *












 *
 *   <li><p> A method for {@link #compact compacting}
 *   a double buffer.  </p></li>
 *
 * </ul>
 *
 * <p> Double buffers can be created either by {@link #allocate
 * <i>allocation</i>}, which allocates space for the buffer's
 *






 *
 * content, by {@link #wrap(double[]) <i>wrapping</i>} an existing
 * double array  into a buffer, or by creating a
 * <a href="ByteBuffer.html#views"><i>view</i></a> of an existing byte buffer.
 *

 *


































































































*

 *
 * <p> Like a byte buffer, a double buffer is either <a
 * href="ByteBuffer.html#direct"><i>direct</i> or <i>non-direct</i></a>.  A
 * double buffer created via the {@code wrap} methods of this class will
 * be non-direct.  A double 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 double buffer is direct may be determined by invoking the {@link
 * #isDirect isDirect} method.  </p>
 *

*








 *



 *
 * <p> 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.
 *































 *
 *
 * @author Mark Reinhold
 * @author JSR-51 Expert Group
 * @since 1.4
 */

public abstract class DoubleBuffer
    extends Buffer
    implements Comparable<DoubleBuffer>
{

    // These fields are declared here rather than in Heap-X-Buffer in order to
    // reduce the number of virtual method invocations needed to access these
    // values, which is especially costly when coding small buffers.
    //
    final double[] hb;                  // Non-null only for heap buffers
    final int offset;
    boolean isReadOnly;

    // Creates a new buffer with the given mark, position, limit, capacity,
    // backing array, and array offset
    //
    DoubleBuffer(int mark, int pos, int lim, int cap,   // package-private
                 double[] hb, int offset)
    {
        super(mark, pos, lim, cap);
        this.hb = hb;
        this.offset = offset;
    }

    // Creates a new buffer with the given mark, position, limit, and capacity
    //
    DoubleBuffer(int mark, int pos, int lim, int cap) { // package-private
        this(mark, pos, lim, cap, null, 0);
    }

    @Override
    Object base() {
        return hb;
    }


























    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. 
Params: capacity – 
        The new buffer's capacity, in doubles
Throws: IllegalArgumentException –  If the capacity is a negative integer
Returns:  The new double buffer/**
     * Allocates a new double buffer.
     *
     * <p> 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 {@link ByteOrder#nativeOrder native order} of the underlying
     * hardware.

     * It will have a {@link #array backing array}, and its
     * {@link #arrayOffset array offset} will be zero.
     *
     * @param  capacity
     *         The new buffer's capacity, in doubles
     *
     * @return  The new double buffer
     *
     * @throws  IllegalArgumentException
     *          If the {@code capacity} is a negative integer
     */
    public static DoubleBuffer allocate(int capacity) {
        if (capacity < 0)
            throw createCapacityException(capacity);
        return new HeapDoubleBuffer(capacity, capacity);
    }

    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. 
Params: array – 
        The array that will back the new buffer
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.
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.
Throws: IndexOutOfBoundsException –  If the preconditions on the offset and length parameters do not hold
Returns:  The new double buffer/**
     * Wraps a double array into a buffer.
     *
     * <p> 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
     * {@code array.length}, its position will be {@code offset}, its limit
     * will be {@code offset + length}, its mark will be undefined, and its
     * byte order will be



     * the {@link ByteOrder#nativeOrder native order} of the underlying
     * hardware.

     * Its {@link #array backing array} will be the given array, and
     * its {@link #arrayOffset array offset} will be zero.  </p>
     *
     * @param  array
     *         The array that will back the new buffer
     *
     * @param  offset
     *         The offset of the subarray to be used; must be non-negative and
     *         no larger than {@code array.length}.  The new buffer's position
     *         will be set to this value.
     *
     * @param  length
     *         The length of the subarray to be used;
     *         must be non-negative and no larger than
     *         {@code array.length - offset}.
     *         The new buffer's limit will be set to {@code offset + length}.
     *
     * @return  The new double buffer
     *
     * @throws  IndexOutOfBoundsException
     *          If the preconditions on the {@code offset} and {@code length}
     *          parameters do not hold
     */
    public static DoubleBuffer wrap(double[] array,
                                    int offset, int length)
    {
        try {
            return new HeapDoubleBuffer(array, offset, length);
        } catch (IllegalArgumentException x) {
            throw new IndexOutOfBoundsException();
        }
    }

    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. 
Params: array – 
        The array that will back this buffer
Returns:  The new double buffer/**
     * Wraps a double array into a buffer.
     *
     * <p> 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
     * {@code array.length}, its position will be zero, its mark will be
     * undefined, and its byte order will be



     * the {@link ByteOrder#nativeOrder native order} of the underlying
     * hardware.

     * Its {@link #array backing array} will be the given array, and its
     * {@link #arrayOffset array offset} will be zero.  </p>
     *
     * @param  array
     *         The array that will back this buffer
     *
     * @return  The new double buffer
     */
    public static DoubleBuffer wrap(double[] array) {
        return wrap(array, 0, array.length);
    }






























































































    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.  
Returns:  The new double buffer/**
     * Creates a new double buffer whose content is a shared subsequence of
     * this buffer's content.
     *
     * <p> 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.
     *
     * <p> 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.  </p>
     *
     * @return  The new double buffer




     */
    @Override
    public abstract DoubleBuffer slice();

    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.  
Returns:  The new double buffer/**
     * Creates a new double buffer that shares this buffer's content.
     *
     * <p> 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.
     *
     * <p> 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.  </p>
     *
     * @return  The new double buffer
     */
    @Override
    public abstract DoubleBuffer duplicate();

    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. 
Returns:  The new, read-only double buffer/**
     * Creates a new, read-only double buffer that shares this buffer's
     * content.
     *
     * <p> 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.
     *
     * <p> The new buffer's capacity, limit, position,




     * mark values, and byte order will be identical to those of this buffer.

     *
     * <p> If this buffer is itself read-only then this method behaves in
     * exactly the same way as the {@link #duplicate duplicate} method.  </p>
     *
     * @return  The new, read-only double buffer
     */
    public abstract DoubleBuffer asReadOnlyBuffer();


    // -- Singleton get/put methods --

    Relative get method.  Reads the double at this buffer's
current position, and then increments the position.
Throws: BufferUnderflowException – 
         If the buffer's current position is not smaller than its limit
Returns:  The double at the buffer's current position/**
     * Relative <i>get</i> method.  Reads the double at this buffer's
     * current position, and then increments the position.
     *
     * @return  The double at the buffer's current position
     *
     * @throws  BufferUnderflowException
     *          If the buffer's current position is not smaller than its limit
     */
    public abstract double get();

    Relative put method  (optional operation).
 Writes the given double into this buffer at the current
position, and then increments the position. 
Params: d – 
        The double to be written
Throws: BufferOverflowException – 
         If this buffer's current position is not smaller than its limit
ReadOnlyBufferException – 
         If this buffer is read-only
Returns:  This buffer/**
     * Relative <i>put</i> method&nbsp;&nbsp;<i>(optional operation)</i>.
     *
     * <p> Writes the given double into this buffer at the current
     * position, and then increments the position. </p>
     *
     * @param  d
     *         The double to be written
     *
     * @return  This buffer
     *
     * @throws  BufferOverflowException
     *          If this buffer's current position is not smaller than its limit
     *
     * @throws  ReadOnlyBufferException
     *          If this buffer is read-only
     */
    public abstract DoubleBuffer put(double d);

    Absolute get method.  Reads the double at the given
index.
Params: index – 
        The index from which the double will be read
Throws: IndexOutOfBoundsException –  If index is negative or not smaller than the buffer's limit
Returns:  The double at the given index/**
     * Absolute <i>get</i> method.  Reads the double at the given
     * index.
     *
     * @param  index
     *         The index from which the double will be read
     *
     * @return  The double at the given index
     *
     * @throws  IndexOutOfBoundsException
     *          If {@code index} is negative
     *          or not smaller than the buffer's limit
     */
    public abstract double get(int index);














    Absolute put method  (optional operation).
 Writes the given double into this buffer at the given
index. 
Params: index – 
        The index at which the double will be written
d – 
        The double value to be written
Throws: IndexOutOfBoundsException –  If index is negative or not smaller than the buffer's limit
ReadOnlyBufferException – 
         If this buffer is read-only
Returns:  This buffer/**
     * Absolute <i>put</i> method&nbsp;&nbsp;<i>(optional operation)</i>.
     *
     * <p> Writes the given double into this buffer at the given
     * index. </p>
     *
     * @param  index
     *         The index at which the double will be written
     *
     * @param  d
     *         The double value to be written
     *
     * @return  This buffer
     *
     * @throws  IndexOutOfBoundsException
     *          If {@code index} is negative
     *          or not smaller than the buffer's limit
     *
     * @throws  ReadOnlyBufferException
     *          If this buffer is read-only
     */
    public abstract DoubleBuffer put(int index, double d);


    // -- Bulk get operations --

    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.
Params: dst – 
        The array into which doubles are to be written
offset –  The offset within the array of the first double to be written; must be non-negative and no larger than dst.length
length –  The maximum number of doubles to be written to the given array; must be non-negative and no larger than dst.length - offset
Throws: BufferUnderflowException –  If there are fewer than length doubles remaining in this buffer
IndexOutOfBoundsException –  If the preconditions on the offset and length parameters do not hold
Returns:  This buffer/**
     * Relative bulk <i>get</i> method.
     *
     * <p> 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
     * {@code length}&nbsp;{@code >}&nbsp;{@code remaining()}, then no
     * doubles are transferred and a {@link BufferUnderflowException} is
     * thrown.
     *
     * <p> Otherwise, this method copies {@code 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 {@code length}.
     *
     * <p> In other words, an invocation of this method of the form
     * <code>src.get(dst,&nbsp;off,&nbsp;len)</code> has exactly the same effect as
     * the loop
     *
     * <pre>{@code
     *     for (int i = off; i < off + len; i++)
     *         dst[i] = src.get();
     * }</pre>
     *
     * except that it first checks that there are sufficient doubles in
     * this buffer and it is potentially much more efficient.
     *
     * @param  dst
     *         The array into which doubles are to be written
     *
     * @param  offset
     *         The offset within the array of the first double to be
     *         written; must be non-negative and no larger than
     *         {@code dst.length}
     *
     * @param  length
     *         The maximum number of doubles to be written to the given
     *         array; must be non-negative and no larger than
     *         {@code dst.length - offset}
     *
     * @return  This buffer
     *
     * @throws  BufferUnderflowException
     *          If there are fewer than {@code length} doubles
     *          remaining in this buffer
     *
     * @throws  IndexOutOfBoundsException
     *          If the preconditions on the {@code offset} and {@code length}
     *          parameters do not hold
     */
    public DoubleBuffer get(double[] dst, int offset, int length) {
        checkBounds(offset, length, dst.length);
        if (length > remaining())
            throw new BufferUnderflowException();
        int end = offset + length;
        for (int i = offset; i < end; i++)
            dst[i] = get();
        return this;
    }

    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) 
Params: dst – 
         The destination array
Throws: BufferUnderflowException –  If there are fewer than length doubles remaining in this buffer
Returns:  This buffer/**
     * Relative bulk <i>get</i> method.
     *
     * <p> This method transfers doubles from this buffer into the given
     * destination array.  An invocation of this method of the form
     * {@code src.get(a)} behaves in exactly the same way as the invocation
     *
     * <pre>
     *     src.get(a, 0, a.length) </pre>
     *
     * @param   dst
     *          The destination array
     *
     * @return  This buffer
     *
     * @throws  BufferUnderflowException
     *          If there are fewer than {@code length} doubles
     *          remaining in this buffer
     */
    public DoubleBuffer get(double[] dst) {
        return get(dst, 0, dst.length);
    }


    // -- Bulk put operations --

    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.
Params: src – 
        The source buffer from which doubles are to be read;
        must not be this buffer
Throws: BufferOverflowException – 
         If there is insufficient space in this buffer
         for the remaining doubles in the source buffer
IllegalArgumentException – 
         If the source buffer is this buffer
ReadOnlyBufferException – 
         If this buffer is read-only
Returns:  This buffer/**
     * Relative bulk <i>put</i> method&nbsp;&nbsp;<i>(optional operation)</i>.
     *
     * <p> 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
     * {@code src.remaining()}&nbsp;{@code >}&nbsp;{@code remaining()},
     * then no doubles are transferred and a {@link
     * BufferOverflowException} is thrown.
     *
     * <p> Otherwise, this method copies
     * <i>n</i>&nbsp;=&nbsp;{@code 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 <i>n</i>.
     *
     * <p> In other words, an invocation of this method of the form
     * {@code dst.put(src)} has exactly the same effect as the loop
     *
     * <pre>
     *     while (src.hasRemaining())
     *         dst.put(src.get()); </pre>
     *
     * except that it first checks that there is sufficient space in this
     * buffer and it is potentially much more efficient.
     *
     * @param  src
     *         The source buffer from which doubles are to be read;
     *         must not be this buffer
     *
     * @return  This buffer
     *
     * @throws  BufferOverflowException
     *          If there is insufficient space in this buffer
     *          for the remaining doubles in the source buffer
     *
     * @throws  IllegalArgumentException
     *          If the source buffer is this buffer
     *
     * @throws  ReadOnlyBufferException
     *          If this buffer is read-only
     */
    public DoubleBuffer put(DoubleBuffer src) {
        if (src == this)
            throw createSameBufferException();
        if (isReadOnly())
            throw new ReadOnlyBufferException();
        int n = src.remaining();
        if (n > remaining())
            throw new BufferOverflowException();
        for (int i = 0; i < n; i++)
            put(src.get());
        return this;
    }

    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.
Params: src – 
        The array from which doubles are to be read
offset –  The offset within the array of the first double to be read; must be non-negative and no larger than array.length
length –  The number of doubles to be read from the given array; must be non-negative and no larger than array.length - offset
Throws: 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
Returns:  This buffer/**
     * Relative bulk <i>put</i> method&nbsp;&nbsp;<i>(optional operation)</i>.
     *
     * <p> 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
     * {@code length}&nbsp;{@code >}&nbsp;{@code remaining()}, then no
     * doubles are transferred and a {@link BufferOverflowException} is
     * thrown.
     *
     * <p> Otherwise, this method copies {@code 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 {@code length}.
     *
     * <p> In other words, an invocation of this method of the form
     * <code>dst.put(src,&nbsp;off,&nbsp;len)</code> has exactly the same effect as
     * the loop
     *
     * <pre>{@code
     *     for (int i = off; i < off + len; i++)
     *         dst.put(a[i]);
     * }</pre>
     *
     * except that it first checks that there is sufficient space in this
     * buffer and it is potentially much more efficient.
     *
     * @param  src
     *         The array from which doubles are to be read
     *
     * @param  offset
     *         The offset within the array of the first double to be read;
     *         must be non-negative and no larger than {@code array.length}
     *
     * @param  length
     *         The number of doubles to be read from the given array;
     *         must be non-negative and no larger than
     *         {@code array.length - offset}
     *
     * @return  This buffer
     *
     * @throws  BufferOverflowException
     *          If there is insufficient space in this buffer
     *
     * @throws  IndexOutOfBoundsException
     *          If the preconditions on the {@code offset} and {@code length}
     *          parameters do not hold
     *
     * @throws  ReadOnlyBufferException
     *          If this buffer is read-only
     */
    public DoubleBuffer put(double[] src, int offset, int length) {
        checkBounds(offset, length, src.length);
        if (length > remaining())
            throw new BufferOverflowException();
        int end = offset + length;
        for (int i = offset; i < end; i++)
            this.put(src[i]);
        return this;
    }

    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) 
Params: src – 
         The source array
Throws: BufferOverflowException – 
         If there is insufficient space in this buffer
ReadOnlyBufferException – 
         If this buffer is read-only
Returns:  This buffer/**
     * Relative bulk <i>put</i> method&nbsp;&nbsp;<i>(optional operation)</i>.
     *
     * <p> This method transfers the entire content of the given source
     * double array into this buffer.  An invocation of this method of the
     * form {@code dst.put(a)} behaves in exactly the same way as the
     * invocation
     *
     * <pre>
     *     dst.put(a, 0, a.length) </pre>
     *
     * @param   src
     *          The source array
     *
     * @return  This buffer
     *
     * @throws  BufferOverflowException
     *          If there is insufficient space in this buffer
     *
     * @throws  ReadOnlyBufferException
     *          If this buffer is read-only
     */
    public final DoubleBuffer put(double[] src) {
        return put(src, 0, src.length);
    }































































































    // -- Other stuff --

    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. 
Returns:  true if, and only if, this buffer is backed by an array and is not read-only/**
     * Tells whether or not this buffer is backed by an accessible double
     * array.
     *
     * <p> If this method returns {@code true} then the {@link #array() array}
     * and {@link #arrayOffset() arrayOffset} methods may safely be invoked.
     * </p>
     *
     * @return  {@code true} if, and only if, this buffer
     *          is backed by an array and is not read-only
     */
    public final boolean hasArray() {
        return (hb != null) && !isReadOnly;
    }

    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. 
Throws: ReadOnlyBufferException – 
         If this buffer is backed by an array but is read-only
UnsupportedOperationException – 
         If this buffer is not backed by an accessible array
Returns:  The array that backs this buffer/**
     * Returns the double array that backs this
     * buffer&nbsp;&nbsp;<i>(optional operation)</i>.
     *
     * <p> Modifications to this buffer's content will cause the returned
     * array's content to be modified, and vice versa.
     *
     * <p> Invoke the {@link #hasArray hasArray} method before invoking this
     * method in order to ensure that this buffer has an accessible backing
     * array.  </p>
     *
     * @return  The array that backs this buffer
     *
     * @throws  ReadOnlyBufferException
     *          If this buffer is backed by an array but is read-only
     *
     * @throws  UnsupportedOperationException
     *          If this buffer is not backed by an accessible array
     */
    public final double[] array() {
        if (hb == null)
            throw new UnsupportedOperationException();
        if (isReadOnly)
            throw new ReadOnlyBufferException();
        return hb;
    }

    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. 
Throws: ReadOnlyBufferException – 
         If this buffer is backed by an array but is read-only
UnsupportedOperationException – 
         If this buffer is not backed by an accessible array
Returns:  The offset within this buffer's array
         of the first element of the buffer/**
     * Returns the offset within this buffer's backing array of the first
     * element of the buffer&nbsp;&nbsp;<i>(optional operation)</i>.
     *
     * <p> If this buffer is backed by an array then buffer position <i>p</i>
     * corresponds to array index <i>p</i>&nbsp;+&nbsp;{@code arrayOffset()}.
     *
     * <p> Invoke the {@link #hasArray hasArray} method before invoking this
     * method in order to ensure that this buffer has an accessible backing
     * array.  </p>
     *
     * @return  The offset within this buffer's array
     *          of the first element of the buffer
     *
     * @throws  ReadOnlyBufferException
     *          If this buffer is backed by an array but is read-only
     *
     * @throws  UnsupportedOperationException
     *          If this buffer is not backed by an accessible array
     */
    public final int arrayOffset() {
        if (hb == null)
            throw new UnsupportedOperationException();
        if (isReadOnly)
            throw new ReadOnlyBufferException();
        return offset;
    }

    // -- Covariant return type overrides

    {@inheritDoc}
/**
     * {@inheritDoc}
     */
    @Override
    public

    final

    DoubleBuffer position(int newPosition) {
        super.position(newPosition);
        return this;
    }
    
    {@inheritDoc}
/**
     * {@inheritDoc}
     */
    @Override
    public

    final

    DoubleBuffer limit(int newLimit) {
        super.limit(newLimit);
        return this;
    }
    
    {@inheritDoc}
/**
     * {@inheritDoc}
     */
    @Override
    public 

    final

    DoubleBuffer mark() {
        super.mark();
        return this;
    }

    {@inheritDoc}
/**
     * {@inheritDoc}
     */
    @Override
    public 

    final

    DoubleBuffer reset() {
        super.reset();
        return this;
    }

    {@inheritDoc}
/**
     * {@inheritDoc}
     */
    @Override
    public 

    final

    DoubleBuffer clear() {
        super.clear();
        return this;
    }

    {@inheritDoc}
/**
     * {@inheritDoc}
     */
    @Override
    public 

    final

    DoubleBuffer flip() {
        super.flip();
        return this;
    }

    {@inheritDoc}
/**
     * {@inheritDoc}
     */
    @Override
    public 

    final

    DoubleBuffer rewind() {
        super.rewind();
        return this;
    }

    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. 
Throws: ReadOnlyBufferException – 
         If this buffer is read-only
Returns:  This buffer/**
     * Compacts this buffer&nbsp;&nbsp;<i>(optional operation)</i>.
     *
     * <p> 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 <i>p</i>&nbsp;=&nbsp;{@code position()} is copied
     * to index zero, the double at index <i>p</i>&nbsp;+&nbsp;1 is copied
     * to index one, and so forth until the double at index
     * {@code limit()}&nbsp;-&nbsp;1 is copied to index
     * <i>n</i>&nbsp;=&nbsp;{@code limit()}&nbsp;-&nbsp;{@code 1}&nbsp;-&nbsp;<i>p</i>.
     * The buffer's position is then set to <i>n+1</i> and its limit is set to
     * its capacity.  The mark, if defined, is discarded.
     *
     * <p> 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 <i>put</i>
     * method. </p>
     *
















     *
     * @return  This buffer
     *
     * @throws  ReadOnlyBufferException
     *          If this buffer is read-only
     */
    public abstract DoubleBuffer compact();

    Tells whether or not this double buffer is direct.
Returns:  true if, and only if, this buffer is direct/**
     * Tells whether or not this double buffer is direct.
     *
     * @return  {@code true} if, and only if, this buffer is direct
     */
    public abstract boolean isDirect();



    Returns a string summarizing the state of this buffer.
Returns:  A summary string/**
     * Returns a string summarizing the state of this buffer.
     *
     * @return  A summary string
     */
    public String toString() {
        StringBuffer sb = new StringBuffer();
        sb.append(getClass().getName());
        sb.append("[pos=");
        sb.append(position());
        sb.append(" lim=");
        sb.append(limit());
        sb.append(" cap=");
        sb.append(capacity());
        sb.append("]");
        return sb.toString();
    }






    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.  
Returns:  The current hash code of this buffer/**
     * Returns the current hash code of this buffer.
     *
     * <p> The hash code of a double buffer depends only upon its remaining
     * elements; that is, upon the elements from {@code position()} up to, and
     * including, the element at {@code limit()}&nbsp;-&nbsp;{@code 1}.
     *
     * <p> 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.  </p>
     *
     * @return  The current hash code of this buffer
     */
    public int hashCode() {
        int h = 1;
        int p = position();
        for (int i = limit() - 1; i >= p; i--)



            h = 31 * h + (int)get(i);

        return h;
    }

    Tells whether or not this buffer is equal to another object.
 Two double 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 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.  
Params: ob –  The object to which this buffer is to be compared
Returns:  true if, and only if, this buffer is equal to the given object/**
     * Tells whether or not this buffer is equal to another object.
     *
     * <p> Two double buffers are equal if, and only if,
     *
     * <ol>
     *
     *   <li><p> They have the same element type,  </p></li>
     *
     *   <li><p> They have the same number of remaining elements, and
     *   </p></li>
     *
     *   <li><p> The two sequences of remaining elements, considered
     *   independently of their starting positions, are pointwise equal.

     *   This method considers two double elements {@code a} and {@code b}
     *   to be equal if
     *   {@code (a == b) || (Double.isNaN(a) && Double.isNaN(b))}.
     *   The values {@code -0.0} and {@code +0.0} are considered to be
     *   equal, unlike {@link Double#equals(Object)}.

     *   </p></li>
     *
     * </ol>
     *
     * <p> A double buffer is not equal to any other type of object.  </p>
     *
     * @param  ob  The object to which this buffer is to be compared
     *
     * @return  {@code true} if, and only if, this buffer is equal to the
     *           given object
     */
    public boolean equals(Object ob) {
        if (this == ob)
            return true;
        if (!(ob instanceof DoubleBuffer))
            return false;
        DoubleBuffer that = (DoubleBuffer)ob;
        if (this.remaining() != that.remaining())
            return false;
        return BufferMismatch.mismatch(this, this.position(),
                                       that, that.position(),
                                       this.remaining()) < 0;
    }

    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.
Returns:  A negative integer, zero, or a positive integer as this buffer
         is less than, equal to, or greater than the given buffer/**
     * Compares this buffer to another.
     *
     * <p> 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 {@code double} elements are compared as if by invoking
     * {@link Double#compare(double,double)}, except that
     * {@code -0.0} and {@code 0.0} are considered to be equal.
     * {@code Double.NaN} is considered by this method to be equal
     * to itself and greater than all other {@code double} values
     * (including {@code Double.POSITIVE_INFINITY}).




     *
     * <p> A double buffer is not comparable to any other type of object.
     *
     * @return  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(DoubleBuffer that) {
        int i = BufferMismatch.mismatch(this, this.position(),
                                        that, that.position(),
                                        Math.min(this.remaining(), that.remaining()));
        if (i >= 0) {
            return compare(this.get(this.position() + i), that.get(that.position() + i));
        }
        return this.remaining() - that.remaining();
    }

    private static int compare(double x, double y) {

        return ((x < y)  ? -1 :
                (x > y)  ? +1 :
                (x == y) ?  0 :
                Double.isNaN(x) ? (Double.isNaN(y) ? 0 : +1) : -1);



    }

    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.
Params: that – 
        The byte buffer to be tested for a mismatch with this buffer
Returns:  The relative index of the first mismatch between this and the
         given buffer, otherwise -1 if no mismatch.
Since: 11/**
     * Finds and returns the relative index of the first mismatch between this
     * buffer and a given buffer.  The index is relative to the
     * {@link #position() position} of each buffer and will be in the range of
     * 0 (inclusive) up to the smaller of the {@link #remaining() remaining}
     * elements in each buffer (exclusive).
     *
     * <p> 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.
     *
     * @param  that
     *         The byte buffer to be tested for a mismatch with this buffer
     *
     * @return  The relative index of the first mismatch between this and the
     *          given buffer, otherwise -1 if no mismatch.
     *
     * @since 11
     */
    public int mismatch(DoubleBuffer that) {
        int length = Math.min(this.remaining(), that.remaining());
        int r = BufferMismatch.mismatch(this, this.position(),
                                        that, that.position(),
                                        length);
        return (r == -1 && this.remaining() != that.remaining()) ? length : r;
    }

    // -- Other char stuff --


































































































































































































    // -- Other byte stuff: Access to binary data --



    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.  
Returns:  This buffer's byte order/**
     * Retrieves this buffer's byte order.
     *
     * <p> The byte order of a double buffer created by allocation or by
     * wrapping an existing {@code double} array is the {@link
     * ByteOrder#nativeOrder native order} of the underlying
     * hardware.  The byte order of a double buffer created as a <a
     * href="ByteBuffer.html#views">view</a> of a byte buffer is that of the
     * byte buffer at the moment that the view is created.  </p>
     *
     * @return  This buffer's byte order
     */
    public abstract ByteOrder order();











































































































































































































}
Params:	capacity – The new buffer's capacity, in doubles
Throws:	IllegalArgumentException – If the `capacity` is a negative integer
Returns:	The new double buffer
Params:	array – The array that will back the new buffer 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. 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`.
Throws:	IndexOutOfBoundsException – If the preconditions on the `offset` and `length` parameters do not hold
Returns:	The new double buffer
Params:	array – The array that will back this buffer
Returns:	The new double buffer
Throws:	BufferUnderflowException – If the buffer's current position is not smaller than its limit
Returns:	The double at the buffer's current position
Params:	d – The double to be written
Throws:	BufferOverflowException – If this buffer's current position is not smaller than its limit ReadOnlyBufferException – If this buffer is read-only
Returns:	This buffer
Params:	index – The index from which the double will be read
Throws:	IndexOutOfBoundsException – If `index` is negative or not smaller than the buffer's limit
Returns:	The double at the given index
Params:	index – The index at which the double will be written d – The double value to be written
Throws:	IndexOutOfBoundsException – If `index` is negative or not smaller than the buffer's limit ReadOnlyBufferException – If this buffer is read-only
Returns:	This buffer
Params:	dst – The array into which doubles are to be written offset – The offset within the array of the first double to be written; must be non-negative and no larger than `dst.length` length – The maximum number of doubles to be written to the given array; must be non-negative and no larger than `dst.length - offset`
Throws:	BufferUnderflowException – If there are fewer than `length` doubles remaining in this buffer IndexOutOfBoundsException – If the preconditions on the `offset` and `length` parameters do not hold
Returns:	This buffer
Params:	dst – The destination array
Throws:	BufferUnderflowException – If there are fewer than `length` doubles remaining in this buffer
Returns:	This buffer
Params:	src – The source buffer from which doubles are to be read; must not be this buffer
Throws:	BufferOverflowException – If there is insufficient space in this buffer for the remaining doubles in the source buffer IllegalArgumentException – If the source buffer is this buffer ReadOnlyBufferException – If this buffer is read-only
Returns:	This buffer
Params:	src – The array from which doubles are to be read offset – The offset within the array of the first double to be read; must be non-negative and no larger than `array.length` length – The number of doubles to be read from the given array; must be non-negative and no larger than `array.length - offset`
Throws:	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
Returns:	This buffer
Params:	src – The source array
Throws:	BufferOverflowException – If there is insufficient space in this buffer ReadOnlyBufferException – If this buffer is read-only
Returns:	This buffer
Throws:	ReadOnlyBufferException – If this buffer is backed by an array but is read-only UnsupportedOperationException – If this buffer is not backed by an accessible array
Returns:	The array that backs this buffer
Params:	ob – The object to which this buffer is to be compared
Returns:	`true` if, and only if, this buffer is equal to the given object
Params:	that – The byte buffer to be tested for a mismatch with this buffer
Returns:	The relative index of the first mismatch between this and the given buffer, otherwise -1 if no mismatch.
Since:	11
/

java/ 11/ java.base/java/nio/DoubleBuffer.java
