java.nio
クラス FloatBuffer

java.lang.Object
  |
  +--java.nio.Buffer
        |
        +--java.nio.FloatBuffer

すべての実装インタフェース:

Comparable

public abstract class FloatBuffer

extends Buffer

implements Comparable

float バッファです。

このクラスは、float バッファに対する操作を 4 つのカテゴリに分類します。

• 単一の float 値の読み込みと書き込みを行う絶対および相対「get」/「put」メソッド

• 連続した float 値のシーケンスを現在のバッファから配列へと転送する相対「一括 get」メソッド

• 連続した float 値のシーケンスを float 配列やその他の float バッファから現在のバッファへと転送する相対「一括 put」メソッド

• float バッファの圧縮、複製、スライス用メソッド

float バッファは、バッファのコンテンツに容量を割り当てる方法 (容量の割り当て)、既存の float 配列をバッファにラップする方法 (ラップ)、既存の byte バッファの「ビュー」を作成する方法で作成できます。

byte バッファと同様に、float バッファにも「ダイレクト」バッファと「非ダイレクト」バッファがあります。このクラスの wrap メソッドで作成された float バッファは非ダイレクトバッファになります。byte バッファのビューとして作成された float バッファは、byte バッファがダイレクトバッファである場合にかぎりダイレクトバッファになります。float バッファがダイレクトバッファであるかどうかは、isDirect メソッドを呼び出すことで判断できます。

このクラスのメソッドのうち戻り値を返さないものは、自身を呼び出したバッファの情報を返します。これを応用して、メソッド呼び出しを連鎖させることができます。

導入されたバージョン:

1.4

メソッドの概要

static FloatBuffer	allocate(int capacity) 新しい float バッファを割り当てます。
float[]	array() 現在のバッファを補助する float 配列を返します (オプション)。
int	arrayOffset() 現在のバッファの補助配列内にある、このバッファの最初の要素のオフセットを返します (オプション)。
abstract FloatBuffer	asReadOnlyBuffer() 現在のバッファのコンテンツを共有する新しい読み込み専用 float バッファを作成します。
abstract FloatBuffer	compact() 現在のバッファを圧縮します (オプション)。
int	compareTo(Object ob) 現在のバッファを別のオブジェクトと比較します。
abstract FloatBuffer	duplicate() 現在のバッファのコンテンツを共有する新しい float バッファを作成します。
boolean	equals(Object ob) 現在のバッファが別のオブジェクトと等価であるかどうかを判断します。
abstract float	get() 相対「get」メソッドです。
FloatBuffer	get(float[] dst) 相対一括「get」メソッドです。
FloatBuffer	get(float[] dst, int offset, int length) 相対一括「get」メソッドです。
abstract float	get(int index) 絶対「get」メソッドです。
boolean	hasArray() 現在のバッファがアクセス可能な float 配列を利用するかどうかを判断します。
int	hashCode() 現在のバッファの現在のハッシュコードを返します。
abstract boolean	isDirect() 現在の float バッファがダイレクトバッファであるかどうかを判断します。
abstract ByteOrder	order() 現在のバッファのバイト順序を取得します。
abstract FloatBuffer	put(float f) 相対「put」メソッドです (オプション)。
FloatBuffer	put(float[] src) 相対一括「put」メソッドです (オプション)。
FloatBuffer	put(float[] src, int offset, int length) 相対一括「put」メソッドです (オプション)。
FloatBuffer	put(FloatBuffer src) 相対一括「put」メソッドです (オプション)。
abstract FloatBuffer	put(int index, float f) 絶対「put」メソッドです (オプション)。
abstract FloatBuffer	slice() 現在のバッファのコンテンツの共有サブシーケンスをコンテンツとする新しい float バッファを作成します。
String	toString() 現在のバッファの状態を簡単に説明する文字列を返します。
static FloatBuffer	wrap(float[] array) float 配列をバッファにラップします。
static FloatBuffer	wrap(float[] array, int offset, int length) float 配列をバッファにラップします。

クラス java.nio.Buffer から継承したメソッド

capacity, clear, flip, hasRemaining, isReadOnly, limit, limit, mark, position, position, remaining, reset, rewind

クラス java.lang.Object から継承したメソッド

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

メソッドの詳細

allocate

public static FloatBuffer allocate(int capacity)

新しい float バッファを割り当てます。

新しいバッファの位置は 0、リミットは容量と同じ値になります。マークは定義されません。このバッファは補助配列を利用することになっており、その配列オフセットは 0 です。

パラメータ:

capacity - 新しいバッファの容量 (float)

戻り値:

新しい float バッファ

wrap

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

float 配列をバッファにラップします。

新しいバッファは指定された float 配列を利用します。バッファに変更を加えると float 配列が変更され、float 配列に変更を加えるとバッファが変更されます。新しいバッファの容量は array.length、位置は offset、リミットは offset + length になります。マークは定義されません。指定された配列が補助配列となり、その配列オフセットは 0 になります。

パラメータ:

array - 新しいバッファを補助する配列

offset - 使用するサブ配列の長さ。array.length 以下の正の数でなければならない。新しいバッファの位置は、この値に設定される

length - 使用するサブ配列のオフセット。array.length - offset 以下の正の数でなければならない。新しいバッファのリミットは、offset + length に設定される

戻り値:

新しい float バッファ

例外:

IndexOutOfBoundsException - offset パラメータと length パラメータの前提条件が満たされていない場合

wrap

public static FloatBuffer wrap(float[] array)

float 配列をバッファにラップします。

新しいバッファは指定された float 配列を利用します。バッファに変更を加えると float 配列が変更され、float 配列に変更を加えるとバッファが変更されます。新しいバッファの容量とリミットは array.length、位置は 0 になります。マークは定義されません。指定された配列が補助配列となり、その{@link #arrayOffset 配列オフセットは 0 になります。

パラメータ:

array - 現在のバッファを補助する配列

戻り値:

新しい float バッファ

slice

public abstract FloatBuffer slice()

現在のバッファのコンテンツの共有サブシーケンスをコンテンツとする新しい float バッファを作成します。

新しいバッファのコンテンツは、現在のバッファの現在位置から始まります。現在のバッファのコンテンツに変更を加えると、その内容が新しいバッファに反映されます。新しいバッファのコンテンツに変更を加えると、その内容が現在のバッファに反映されます。2 つのバッファの位置、リミット、マークの値はそれぞれ異なります。

新しいバッファの位置は 0、容量とリミットは現在のバッファ内に残っている float 値の数になります。マークは定義されません。新しいバッファは、現在のバッファがダイレクトバッファである場合にかぎりダイレクトバッファになります。また、現在のバッファが読み込み専用バッファである場合にかぎり読み込み専用バッファになります。

戻り値:

新しい float バッファ

duplicate

public abstract FloatBuffer duplicate()

現在のバッファのコンテンツを共有する新しい float バッファを作成します。

新しいバッファのコンテンツは、現在のバッファのコンテンツと同じになります。現在のバッファのコンテンツに変更を加えると、その内容が新しいバッファに反映されます。新しいバッファのコンテンツに変更を加えると、その内容が現在のバッファに反映されます。2 つのバッファの位置、リミット、マークの値はそれぞれ異なります。

新しいバッファの容量、リミット、位置、マークの値は、現在のバッファの対応する値と同じになります。新しいバッファは、現在のバッファがダイレクトバッファである場合にかぎりダイレクトバッファになります。また、現在のバッファが読み込み専用バッファである場合にかぎり読み込み専用バッファになります。

戻り値:

新しい float バッファ

asReadOnlyBuffer

public abstract FloatBuffer asReadOnlyBuffer()

現在のバッファのコンテンツを共有する新しい読み込み専用 float バッファを作成します。

新しいバッファのコンテンツは、現在のバッファのコンテンツと同じになります。現在のバッファのコンテンツに変更を加えると、その内容が新しいバッファに反映されます。しかし、新しいバッファ自体は読み込み専用であり、その共有コンテンツを変更することはできません。2 つのバッファの位置、リミット、マークの値はそれぞれ異なります。

新しいバッファの容量、リミット、位置、マークの値は、現在のバッファの対応する値と同じになります。

現在のバッファが読み込み専用の場合、このメソッドの動作はduplicateメソッドとまったく同じになります。

戻り値:

新しい読み込み専用 float バッファ

get

public abstract float get()

相対「get」メソッドです。現在のバッファの現在位置にある float 値を読み込み、現在位値を増加します。

戻り値:

バッファの現在位置の float 値

例外:

BufferUnderflowException - バッファの現在位置がリミット以上である場合

put

public abstract FloatBuffer put(float f)

相対「put」メソッドです (オプション)。

現在のバッファの現在位置に指定された float 値を書き込み、現在位置を増加します。

パラメータ:

f - 書き込まれる float 値

戻り値:

現在のバッファ

例外:

BufferOverflowException - 現在のバッファの現在位置がリミット以上である場合

ReadOnlyBufferException - 現在のバッファが読み込み専用バッファである場合

get

public abstract float get(int index)

絶対「get」メソッドです。指定されたインデックス位置の float 値を読み込みます。

パラメータ:

index - float 値の読み込み位置を示すインデックス

戻り値:

指定されたインデックス位置の float 値

例外:

IndexOutOfBoundsException - index が負の数である場合、またはバッファのリミット以上である場合

put

public abstract FloatBuffer put(int index,
                                float f)

絶対「put」メソッドです (オプション)。

現在のバッファの指定されたインデックス位置に指定された float 値を書き込みます。

パラメータ:

index - float 値の書き込み先を示すインデックス

f - 書き込まれる float 値

戻り値:

現在のバッファ

例外:

IndexOutOfBoundsException - index が負の数である場合、またはバッファのリミット以上である場合

ReadOnlyBufferException - 現在のバッファが読み込み専用バッファである場合

get

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

相対一括「get」メソッドです。

このメソッドは、現在のバッファから指定された配列へ float 値を転送します。現在のバッファ内に残っている float 値の数が要求に満たない場合 (length > remaining())、float 値は一切転送されず、BufferUnderflowException がスローされます。

それ以外の場合、このメソッドは、現在のバッファの現在位置から length 個の float 値を指定された配列の指定されたオフセット位置へコピーします。そのたびに、現在のバッファの位置が length ずつ増加します。

このメソッドを src.get(dst, off, len) の形式で呼び出すと、以下のループとまったく同じ結果になります。

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

ただし、現在のバッファ内に十分な数の float 値が存在することを最初に確認する動作は、このメソッドに固有です。また、このメソッドのほうがループよりもずっと効率的です。

パラメータ:

dst - float 値の書き込み先となる配列

offset - 最初の float 値の書き込み先となる配列内のオフセット。dst.length 以下の正の数でなければならない

length - 指定された配列に書き込まれる float 値の最大数。dst.length - offset 以下の正の数でなければならない

戻り値:

現在のバッファ

例外:

BufferUnderflowException - 現在のバッファ内に残っている float 値の数が length よりも少ない場合

IndexOutOfBoundsException - offset パラメータと length パラメータの前提条件が満たされていない場合

get

public FloatBuffer get(float[] dst)

相対一括「get」メソッドです。

このメソッドは、現在のバッファから指定された配列へ float 値を転送します。このメソッドを src.get(a) の形式で呼び出すと、以下の呼び出しと同じ結果になります。

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

戻り値:

現在のバッファ

例外:

BufferUnderflowException - 現在のバッファ内に残っている float 値の数が length よりも少ない場合

put

public FloatBuffer put(FloatBuffer src)

相対一括「put」メソッドです (オプション)。

このメソッドは、指定されたソースバッファ内に残っている float 値を現在のバッファへ転送します。ソースバッファ内に残っている float 値の数が現在のバッファ内に残っている float 値の数よりも多い場合 (src.remaining() > remaining())、float 値は一切転送されず、BufferOverflowException がスローされます。

それ以外の場合、このメソッドは、指定されたバッファの現在位置から現在のバッファの現在位置へ n = src.remaining() 個の float 値をコピーします。そのたびに、両方のバッファの位置が n ずつ増加します。

このメソッドを dst.put(src) の形式で呼び出すと、以下のループとまったく同じ結果になります。

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

ただし、現在のバッファ内に十分な容量があることを最初に確認する動作は、このメソッドに固有です。また、このメソッドのほうがループよりもずっと効率的です。

パラメータ:

src - float 値が読み込まれるソースバッファ (現在のバッファ以外)

戻り値:

現在のバッファ

例外:

BufferOverflowException - 現在のバッファに、ソースバッファの float 値を格納できるだけの容量がない場合

IllegalArgumentException - ソースバッファとして現在のバッファを指定した場合

ReadOnlyBufferException - 現在のバッファが読み込み専用バッファである場合

put

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

相対一括「put」メソッドです (オプション)。

このメソッドは、指定されたソース配列から現在のバッファへ float 値を転送します。配列からコピーする float 値の数が現在のバッファ内に残っている float 値の数より多い場合 (length > remaining())、float 値は一切転送されず、BufferOverflowException がスローされます。

それ以外の場合、このメソッドは、指定された配列の指定されたオフセット位置から現在のバッファの現在位置へ length 個の float 値をコピーします。そのたびに、現在のバッファの位置が length ずつ増加します。

このメソッドを dst.put(src, off, len) の形式で呼び出すと、以下のループとまったく同じ結果になります。

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

ただし、現在のバッファ内に十分な容量があることを最初に確認する動作は、このメソッドに固有です。また、このメソッドのほうがループよりもずっと効率的です。

パラメータ:

offset - 最初の float 値が読み込まれる配列内のオフセット。array.length 以下の正の数でなければならない

length - 指定された配列から読み取られる float 値の数。array.length - offset 以下の正の数でなければならない

戻り値:

現在のバッファ

例外:

BufferOverflowException - 現在のバッファ内に残っている容量が不足している場合

IndexOutOfBoundsException - offset パラメータと length パラメータの前提条件が満たされていない場合

ReadOnlyBufferException - 現在のバッファが読み込み専用バッファである場合

put

public final FloatBuffer put(float[] src)

相対一括「put」メソッドです (オプション)。

このメソッドは、ソースとなる指定された float 配列のコンテンツ全体を現在のバッファへ転送します。このメソッドを dst.put(a) の形式で呼び出すと、以下の呼び出しと同じ結果になります。

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

戻り値:

現在のバッファ

例外:

BufferOverflowException - 現在のバッファ内に残っている容量が不足している場合

ReadOnlyBufferException - 現在のバッファが読み込み専用バッファである場合

hasArray

public final boolean hasArray()

現在のバッファがアクセス可能な float 配列を利用するかどうかを判断します。

このメソッドの戻り値が true であれば、array メソッドと arrayOffset メソッドを安全に呼び出すことができます。

戻り値:

現在のバッファが配列を利用しており、読み込み専用でない場合にかぎり true

array

public final float[] array()

現在のバッファを補助する float 配列を返します (オプション)。

現在のバッファのコンテンツに変更を加えると、返される配列のコンテンツも変更されます。その逆も同様です。

このメソッドを呼び出す前に hasArray メソッドを呼び出し、現在のバッファがアクセス可能な補助配列を持っていることを確認します。

戻り値:

現在のバッファを補助する配列

例外:

ReadOnlyBufferException - 現在のバッファが配列を利用し、しかも読み込み専用である場合

UnsupportedOperationException - 現在のバッファがアクセス可能な配列を利用しない場合

arrayOffset

public final int arrayOffset()

現在のバッファの補助配列内にある、このバッファの最初の要素のオフセットを返します (オプション)。

現在のバッファが配列を利用していれば、その位置 p が配列のインデックス p + arrayOffset() と一致します。

このメソッドを呼び出す前に hasArray メソッドを呼び出し、現在のバッファがアクセス可能な補助配列を持っていることを確認します。

戻り値:

現在のバッファの配列内にある、このバッファの最初の要素のオフセット

例外:

ReadOnlyBufferException - 現在のバッファが配列を利用し、しかも読み込み専用である場合

UnsupportedOperationException - 現在のバッファがアクセス可能な配列を利用しない場合

compact

public abstract FloatBuffer compact()

現在のバッファを圧縮します (オプション)。

バッファの現在位置からリミットまでの間に float 値が存在する場合、これらをバッファの先頭にコピーします。つまり、インデックス位置 p = position() の float 値がインデックス 0 にコピーされ、インデックス位置 p + 1 の float 値がインデックス 1 にコピーされるということです。インデックス位置 limit() - 1 の float 値がインデックス n = limit() - 1 - p にコピーされるまで、同様の処理が繰り返されます。最終的にバッファの位置は n に設定され、リミットは容量の値と等しくなります。マークは破棄されます。

バッファの位置は、0 ではなく、コピーされる float 値の数と等しくなります。したがって、このメソッドを呼び出したあと、すぐに別の相対「put」メソッドを呼び出すことができます。

戻り値:

現在のバッファ

例外:

ReadOnlyBufferException - 現在のバッファが読み込み専用バッファである場合

isDirect

public abstract boolean isDirect()

現在の float バッファがダイレクトバッファであるかどうかを判断します。

戻り値:

現在のバッファがダイレクトバッファである場合にかぎり true

toString

public String toString()

現在のバッファの状態を簡単に説明する文字列を返します。

オーバーライド:

クラス Object 内の toString

戻り値:

概要文字列

hashCode

public int hashCode()

現在のバッファの現在のハッシュコードを返します。

float バッファのハッシュコードは、バッファ内に残っている要素、すなわち position() 〜 limit() - 1 の要素だけに依存します。

バッファのハッシュコードはコンテンツ依存型です。今後バッファのコンテンツが変更されないことが明らかでないかぎり、バッファをハッシュマップその他のデータ構造のキーとして使用することは避けてください。

オーバーライド:

クラス Object 内の hashCode

戻り値:

現在のバッファの現在のハッシュコード

関連項目:

Object.equals(java.lang.Object), Hashtable

equals

public boolean equals(Object ob)

現在のバッファが別のオブジェクトと等価であるかどうかを判断します。

2 つの float バッファは、次の場合にかぎり等価です。

1. 要素の型が同じである

2. バッファ内に残っている要素数が同じである

3. バッファ内に残っている要素のシーケンス (開始位置とは無関係) が各点で等しい

float バッファが、その他の型のオブジェクトと等価になることはありません。

オーバーライド:

クラス Object 内の equals

パラメータ:

ob - 現在のバッファと比較するオブジェクト

戻り値:

現在のバッファが指定されたオブジェクトと等価である場合にかぎり true

関連項目:

Object.hashCode(), Hashtable

compareTo

public int compareTo(Object ob)

現在のバッファを別のオブジェクトと比較します。

2 つの float バッファを比較する際は、バッファ内に残っている要素のシーケンスが辞書順に比較されます。このとき、双方のバッファ内に残っている各シーケンスの開始位置は考慮されません。

float バッファとその他の型のオブジェクトを比較することはできません。

定義:

インタフェース Comparable 内の compareTo

パラメータ:

ob - 比較対象の Object

戻り値:

現在のバッファがもう一方のバッファより小さい場合は負の整数、等しい場合は 0、大きい場合は正の整数

例外:

ClassCastException - 引数が float バッファではない場合

order

public abstract ByteOrder order()

現在のバッファのバイト順序を取得します。

既存の float 配列の割り当てまたはラップによって作成された float バッファのバイト順序は、基本となるハードウェアのネイティブのバイト順序と同じになります。byte バッファのビューとして作成された float バッファのバイト順序は、ビューを作成した時点の byte バッファのバイト順序と同じになります。

戻り値:

現在のバッファのバイト順序