JavaTM Platform
Standard Ed. 6

java.lang
クラス Float

java.lang.Object
  上位を拡張 java.lang.Number
      上位を拡張 java.lang.Float
すべての実装されたインタフェース:
Serializable, Comparable<Float>

public final class Float
extends Number
implements Comparable<Float>

Float クラスは、プリミティブ型 float の値をオブジェクト内にラップします。Float 型のオブジェクトには、float 型の単一のフィールドがあります。

さらにこのクラスは、floatString に、Stringfloat に変換する各種メソッドや、float の処理時に役立つ定数およびメソッドも提供します。

導入されたバージョン:
JDK1.0
関連項目:
直列化された形式

フィールドの概要
static int MAX_EXPONENT
          有限の float 変数が持つ可能性のある最大指数です。
static float MAX_VALUE
          float 型の正の最大有限値 (2-2-23)·2127 です。
static int MIN_EXPONENT
          標準化された float 変数が持つ可能性のある最小指数です。
static float MIN_NORMAL
          float 型の正の最小通常値 2-126 です。
static float MIN_VALUE
          float 型の正の最小有限値 2-149 です。
static float NaN
          float 型の非数 (NaN) 値を保持する定数です。
static float NEGATIVE_INFINITY
          float 型の負の無限大を保持する定数です。
static float POSITIVE_INFINITY
          float 型の正の無限大を保持する定数です。
static int SIZE
          float 値を表すのに使われるビット数
static Class<Float> TYPE
          float のプリミティブ型を表す Class インスタンス
 
コンストラクタの概要
Float(double value)
          float 型に変換された引数を表す、新しく割り当てられた Float オブジェクトを構築します。
Float(float value)
          プリミティブな float 型の引数を表す、新しく割り当てられた Float オブジェクトを構築します。
Float(String s)
          文字列で表される float 型の浮動小数点値を表す、新しく割り当てられた Float オブジェクトを構築します。
 
メソッドの概要
 byte byteValue()
          この Float の値を (byte にキャストすることにより) byte として返します。
static int compare(float f1, float f2)
          指定された 2 つの float 値を比較します。
 int compareTo(Float anotherFloat)
          2 つの Float オブジェクトを数値的に比較します。
 double doubleValue()
          この Float オブジェクトの double 値を返します。
 boolean equals(Object obj)
          オブジェクトと指定されたオブジェクトを比較します。
static int floatToIntBits(float value)
          IEEE 754 浮動小数点の「シングルフォーマット (double format)」ビットレイアウトに従って、指定された浮動小数点の値を表現して返します。
static int floatToRawIntBits(float value)
          IEEE 754 浮動小数点の「シングルフォーマット (double format)」ビットレイアウトに従って、非数 (NaN) 値を保持する、指定された浮動小数点値の表現を返します。
 float floatValue()
          この Float オブジェクトの float 値を返します。
 int hashCode()
          この Float オブジェクトのハッシュコードを返します。
static float intBitsToFloat(int bits)
          指定されたビット表現と対応する float 値を返します。
 int intValue()
          この Float の値を (int 型にキャストすることにより) int として返します。
 boolean isInfinite()
          この Float 値の絶対値が無限量である場合には true を、そうでない場合には false を返します。
static boolean isInfinite(float v)
          指定された数値の絶対値が無限量である場合には true を、そうでない場合には false を返します。
 boolean isNaN()
          この Float 値が非数 (NaN) である場合には true を、そうでない場合は false を返します。
static boolean isNaN(float v)
          指定された数値が非数 (NaN) である場合には true を、そうでない場合は false を返します。
 long longValue()
          この Float の値を (long 型にキャストすることにより) long として返します。
static float parseFloat(String s)
          Float クラスの valueOf メソッドを実行した場合と同様に、指定された String が表す値に初期化された新しい float 値を返します。
 short shortValue()
          この Float の値を (short にキャストすることにより) short として返します。
static String toHexString(float f)
          float 引数の 16 進数文字列表現を返します。
 String toString()
          この Float オブジェクトの文字列表現を返します。
static String toString(float f)
          float 引数の文字列表現を返します。
static Float valueOf(float f)
          指定した float 値を表す Float インスタンスを返します。
static Float valueOf(String s)
          文字列引数 s で表される float 値を保持する Float オブジェクトを返します。
 
クラス java.lang.Object から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

POSITIVE_INFINITY

public static final float POSITIVE_INFINITY
float 型の正の無限大を保持する定数です。Float.intBitsToFloat(0x7f800000) が返す値と同じです。

関連項目:
定数フィールド値

NEGATIVE_INFINITY

public static final float NEGATIVE_INFINITY
float 型の負の無限大を保持する定数です。Float.intBitsToFloat(0xff800000) が返す値と同じです。

関連項目:
定数フィールド値

NaN

public static final float NaN
float 型の非数 (NaN) 値を保持する定数です。Float.intBitsToFloat(0x7fc00000) が返す値と同じです。

関連項目:
定数フィールド値

MAX_VALUE

public static final float MAX_VALUE
float 型の正の最大有限値 (2-2-23)·2127 です。16 進数浮動小数点リテラル 0x1.fffffeP+127f と同等であり、Float.intBitsToFloat(0x7f7fffff) とも同等です。

関連項目:
定数フィールド値

MIN_NORMAL

public static final float MIN_NORMAL
float 型の正の最小通常値 2-126 です。16 進数浮動小数点リテラル 0x1.0p-126f と同等であり、Float.intBitsToFloat(0x00800000) とも同等です。

導入されたバージョン:
1.6
関連項目:
定数フィールド値

MIN_VALUE

public static final float MIN_VALUE
float 型の正の最小有限値 2-149 です。16 進数浮動小数点リテラル 0x0.000002P-126f と同等であり、Float.intBitsToFloat(0x1) とも同等です。

関連項目:
定数フィールド値

MAX_EXPONENT

public static final int MAX_EXPONENT
有限の float 変数が持つ可能性のある最大指数です。Math.getExponent(Float.MAX_VALUE) が返す値と同じです。

導入されたバージョン:
1.6
関連項目:
定数フィールド値

MIN_EXPONENT

public static final int MIN_EXPONENT
標準化された float 変数が持つ可能性のある最小指数です。Math.getExponent(Float.MIN_NORMAL) が返す値と同じです。

導入されたバージョン:
1.6
関連項目:
定数フィールド値

SIZE

public static final int SIZE
float 値を表すのに使われるビット数

導入されたバージョン:
1.5
関連項目:
定数フィールド値

TYPE

public static final Class<Float> TYPE
float のプリミティブ型を表す Class インスタンス

導入されたバージョン:
JDK1.1
コンストラクタの詳細

Float

public Float(float value)
プリミティブな float 型の引数を表す、新しく割り当てられた Float オブジェクトを構築します。

パラメータ:
value - Float によって表される値

Float

public Float(double value)
float 型に変換された引数を表す、新しく割り当てられた Float オブジェクトを構築します。

パラメータ:
value - Float によって表される値

Float

public Float(String s)
      throws NumberFormatException
文字列で表される float 型の浮動小数点値を表す、新しく割り当てられた Float オブジェクトを構築します。文字列は、valueOf メソッドを使う場合と同様にして float 値に変換されます。

パラメータ:
s - Float に変換する文字列
例外:
NumberFormatException - 文字列が解析可能な数値を含まない場合
関連項目:
valueOf(java.lang.String)
メソッドの詳細

toString

public static String toString(float f)
float 引数の文字列表現を返します。次の文字はすべて ASCII 文字です。 m または a の小数部として出力する桁数を検討してみましょう。小数部を表す桁は 1 桁以上が必要です。 float 型の隣接する値から引数を一意に識別するのに最低限必要な桁数にしてください。たとえば、ゼロでない有限の引数 f を指定してこのメソッドで作成した 10 進値表記を x とします。この場合、fxfloat 型の最近似値である必要があります。 つまり、2 つの float 値が均等に x に近似している場合であれば、f は 2 つの値のどちらかでなければならず、有効な最下位ビットは 0 である必要があります。

浮動小数点値のローカライズされた文字列表現を作成する場合、NumberFormat のサブクラスを使用します。

パラメータ:
f - 変換対象の float
戻り値:
この引数の文字列表現

toHexString

public static String toHexString(float f)
float 引数の 16 進数文字列表現を返します。次の文字はすべて ASCII 文字です。

浮動小数点値16 進数文字列
1.0 0x1.0p0
-1.0 -0x1.0p0
2.0 0x1.0p1
3.0 0x1.8p1
0.5 0x1.0p-1
0.25 0x1.0p-2
Float.MAX_VALUE Float.MAX_VALUE
0x1.fffffep127 Minimum Normal Value 0x1.0p-126
Maximum Subnormal Value 0x0.fffffep-126
Float.MIN_VALUE 0x0.000002p-126

パラメータ:
f - 変換対象の float 引数の 16 進数文字列表現
戻り値:
この引数の 16 進数の文字列表現
導入されたバージョン:
1.5

valueOf

public static Float valueOf(String s)
                     throws NumberFormatException
文字列引数 s で表される float 値を保持する Float オブジェクトを返します。  

snull の場合は、 NullPointerException がスローされます。  

s 内の先頭と末尾の空白文字は無視されます。空白文字は、String.trim() メソッドで削除されるときのように削除されます。 つまり、ASCII の空白文字と制御文字の両方が削除されます。s の残りの文字が、次の字句構文規則に従って FloatValue を構成します。

FloatValue:
Signopt NaN
Signopt Infinity
Signopt FloatingPointLiteral
Signopt HexFloatingPointLiteral
SignedInteger

HexFloatingPointLiteral:
HexSignificand BinaryExponent FloatTypeSuffixopt

HexSignificand:
HexNumeral
HexNumeral .
0x HexDigitsopt.HexDigits
0X HexDigitsopt.HexDigits

BinaryExponent:
BinaryExponentIndicator SignedInteger

BinaryExponentIndicator:
p
P
ここで、SignFloatingPointLiteralHexNumeralHexDigitsSignedInteger、および FloatTypeSuffix『Java 言語仕様』の字句構造セクションの定義に従います。sFloatValue の形式でない場合、NumberFormatException がスローされます。そうでない場合、s は通常の「浮動小数点表記」、つまり正確な 10 進値または 16 進値を表していると見なされます。 この正確な数値は、概念上は「無限に正確なバイナリ値」に変換されてから、IEEE 754 浮動小数点計算法による通常の最近似値丸め法 (ゼロ値の符号保持を含む) に従って float 型に丸められます。最後に、float 値を表す Float オブジェクトが返されます。  

浮動小数点値のローカライズされた文字列表現を解釈する場合、NumberFormat のサブクラスを使用します。  

浮動小数点リテラルの型を決定する指示子の末尾形式指示子 (1.0ffloat 値、1.0ddouble 値) は、このメソッドの結果に影響を与えません。つまり、入力文字列の数値は、ターゲットの浮動小数点型に直接変換されます。通常、文字列を double に変換し、doublefloat に変換する 2 段階のシーケンスは、文字列を float に直接変換するのと等価ではありません。たとえば、中間の double に変換し、次に float に変換した場合、文字列
1.00000017881393421514957253748434595763683319091796875001d
の結果は float1.0000002f ですが、文字列を直接 float に変換した場合、結果は 1.0000001f です。  

無効な文字列でこのメソッドが呼び出されたり、NumberFormatException がスローされたりしないようにするために、Double.valueOf のマニュアルには、入力のスクリーニングに使うことができる正規表現が記載されています。

パラメータ:
s - 解析される文字列
戻り値:
String 引数により表される値を保持する Float オブジェクト
例外:
NumberFormatException - 文字列が解析可能な数値を含まない場合

valueOf

public static Float valueOf(float f)
指定した float 値を表す Float インスタンスを返します。新規 Float インスタンスが不要な場合、通常このメソッドがコンストラクタ Float(float) に優先して使用されます。 その理由は、このメソッドが頻繁に要求される値をキャッシュするので、操作に必要な領域や時間がはるかに少なくて済む場合が多いためです。

パラメータ:
f - float 値
戻り値:
f を表す Float インスタンス
導入されたバージョン:
1.5

parseFloat

public static float parseFloat(String s)
                        throws NumberFormatException
Float クラスの valueOf メソッドを実行した場合と同様に、指定された String が表す値に初期化された新しい float 値を返します。

パラメータ:
s - 解析される文字列
戻り値:
文字列引数で表される float
例外:
NumberFormatException - 文字列が構文解析可能な float 値を含まない場合
導入されたバージョン:
1.2
関連項目:
valueOf(String)

isNaN

public static boolean isNaN(float v)
指定された数値が非数 (NaN) である場合には true を、そうでない場合は false を返します。

パラメータ:
v - 判定される値
戻り値:
引数が NaN である場合は true、そうでない場合は false

isInfinite

public static boolean isInfinite(float v)
指定された数値の絶対値が無限量である場合には true を、そうでない場合には false を返します。

パラメータ:
v - 判定される値
戻り値:
引数が正の無限大または負の無限大である場合は true、そうでない場合は false

isNaN

public boolean isNaN()
この Float 値が非数 (NaN) である場合には true を、そうでない場合は false を返します。

戻り値:
このオブジェクトが表す値が NaN である場合は true、そうでない場合は false

isInfinite

public boolean isInfinite()
この Float 値の絶対値が無限量である場合には true を、そうでない場合には false を返します。

戻り値:
このオブジェクトが表す値が正の無限大または負の無限大である場合は true、そうでない場合は false

toString

public String toString()
この Float オブジェクトの文字列表現を返します。このオブジェクトが表すプリミティブ float 値は、1 つの引数を取る toString メソッドを実行した場合と同じ String に変換されます。

オーバーライド:
クラス Object 内の toString
戻り値:
このオブジェクトの String 表現
関連項目:
toString(float)

byteValue

public byte byteValue()
この Float の値を (byte にキャストすることにより) byte として返します。

オーバーライド:
クラス Number 内の byteValue
戻り値:
byte 型に変換されたこのオブジェクトが表す float

shortValue

public short shortValue()
この Float の値を (short にキャストすることにより) short として返します。

オーバーライド:
クラス Number 内の shortValue
戻り値:
short 型に変換されたこのオブジェクトが表す float
導入されたバージョン:
JDK1.1

intValue

public int intValue()
この Float の値を (int 型にキャストすることにより) int として返します。

定義:
クラス Number 内の intValue
戻り値:
int 型に変換されたこのオブジェクトが表す float

longValue

public long longValue()
この Float の値を (long 型にキャストすることにより) long として返します。

定義:
クラス Number 内の longValue
戻り値:
long 型に変換されたこのオブジェクトが表す float

floatValue

public float floatValue()
この Float オブジェクトの float 値を返します。

定義:
クラス Number 内の floatValue
戻り値:
このオブジェクトが表す float

doubleValue

public double doubleValue()
この Float オブジェクトの double 値を返します。

定義:
クラス Number 内の doubleValue
戻り値:
このオブジェクトが表す float 値を double 型に変換した値

hashCode

public int hashCode()
この Float オブジェクトのハッシュコードを返します。結果は、floatToIntBits(float) メソッドで生成した場合とまったく同じように、この Float オブジェクトが表すプリミティブ float 値の int 型ビット表現になります。

オーバーライド:
クラス Object 内の hashCode
戻り値:
このオブジェクトのハッシュコード値
関連項目:
Object.equals(java.lang.Object), Hashtable

equals

public boolean equals(Object obj)
オブジェクトと指定されたオブジェクトを比較します。結果が true になるのは、引数が null でなく、このオブジェクトが表す float 値と同じ値を保持する float を表す Float オブジェクトである場合だけです。このため、2 つの float 値が等しいと見なされるのは、floatToIntBits(float) メソッドを各値に適用したときに同一の int 値が返される場合だけです。

ほとんどの場合、Float クラスの 2 つのインスタンス f1 および f2 について、f1.equals(f2) の値が true になるのは、次の式の値が true になる場合だけです。

   f1.floatValue() == f2.floatValue()
 

しかし、例外事項も 2 つあります。

この定義によって、ハッシュテーブルは正しく動作します。

オーバーライド:
クラス Object 内の equals
パラメータ:
obj - 比較対象のオブジェクト
戻り値:
オブジェクトが同じである場合は true、そうでない場合は false
関連項目:
floatToIntBits(float)

floatToIntBits

public static int floatToIntBits(float value)
IEEE 754 浮動小数点の「シングルフォーマット (double format)」ビットレイアウトに従って、指定された浮動小数点の値を表現して返します。

ビット 31 (マスク 0x80000000 で選択されるビット) は、浮動小数点数値の符号を表すビット 30 〜 23 (マスク 0x7f800000 で選択されるビット) は、指数を表すビット 22 〜 0 (マスク 0x007fffff で選択されるビット) は、浮動小数点数値の有効数字 (仮数) を表す 

引数が正の無限大の場合は、0x7f800000 が返される 

引数が負の無限大の場合は、0xff800000 が返される 

引数が NaN の場合は、0x7fc00000 が返される

どの場合も、返される値は整数であり、intBitsToFloat(int) メソッドを指定すると、floatToIntBits への引数と同じ浮動小数点値になります (すべての NaN 値が単一の「正規」NaN 値に収納されることを除く)。

パラメータ:
value - 浮動小数点値
戻り値:
浮動小数点値を表すビット

floatToRawIntBits

public static int floatToRawIntBits(float value)
IEEE 754 浮動小数点の「シングルフォーマット (double format)」ビットレイアウトに従って、非数 (NaN) 値を保持する、指定された浮動小数点値の表現を返します。

ビット 31 (マスク 0x80000000 で選択されるビット) は、浮動小数点数値の符号を表すビット 30 〜 23 (マスク 0x7f800000 で選択されるビット) は、指数を表すビット 22 〜 0 (マスク 0x007fffff で選択されるビット) は、浮動小数点数値の有効数字 (仮数) を表す 

引数が正の無限大の場合は、0x7f800000 が返される 

引数が負の無限大の場合は、0xff800000 が返される

引数が NaN の場合、返される値は実際の NaN 値を示す整数です。floatToIntBits メソッドとは異なり、floatToRawIntBits メソッドが、すべてのビットパターン符号化 NaN を単一の正規 NaN 値に収納することはありません。

どの場合も、返される値は整数型であり、intBitsToFloat(int) メソッドで指定された場合に、floatToRawIntBits に指定された引数と同じ浮動小数点値が生成されます。

パラメータ:
value - 浮動小数点値
戻り値:
浮動小数点値を表すビット
導入されたバージョン:
1.3

intBitsToFloat

public static float intBitsToFloat(int bits)
指定されたビット表現と対応する float 値を返します。引数は、IEEE 754 浮動小数点「シングルフォーマット (single format)」ビット配列に従った浮動小数点表現と見なされます。

引数が 0x7f800000 の場合は、正の無限大が返されます。

引数が 0xff800000 の場合は、負の無限大が返されます。

引数が 0x7f8000010x7fffffff または 0xff8000010xffffffff の範囲内の値の場合、結果は NaN になります。Java により提供される IEEE 754 浮動小数点操作は、異なるビットパターンを持つ同じ型の 2 つの NaN 値を識別できません。個別の NaN 値を識別できるのは、Float.floatToRawIntBits メソッドを使用する場合だけです。

そのほかの場合では、se、および m の 3 つの値について次の引数から計算できるとします。

 int s = ((bits >> 31) == 0) ? 1 : -1;
 int e = ((bits >> 23) & 0xff);
 int m = (e == 0) ?
                 (bits & 0x7fffff) << 1 :
                 (bits & 0x7fffff) | 0x800000;
 
この場合、浮動小数点値の結果は、数式 s·m·2e-150 の値と等しくなります。

このメソッドは、int 引数とまったく同じビットパターンを持つ float NaN を返すことができない可能性があります。IEEE 754 では、2 種類の NaN (「シグナルを発生しない NaN」と「シグナルを発生する NaN」) を区別します。2 種類の NaN の違いは、通常 Java では確認できません。シグナルを発生する NaN での算術演算では、シグナルを発生する NaN が、異種でありながら同様のビットパターンを持つシグナルを発生しない NaN に変わります。ただし、シグナルを発生する NaN を単にコピーする一部のプロセッサも、この変換も行います。特に、シグナルを発生する NaN をコピーして、呼び出し側のメソッドに返すことで、この変換を実行できます。したがって、intBitsToFloat は、シグナルを発生する NaN ビットパターンを持つ float を返すことができない可能性があります。その結果、一部の int 値では、floatToRawIntBits(intBitsToFloat(start)) は、start と等価ではない場合があります。加えて、どの特定のビットパターンがシグナルを発生する NaN を表すかは、プラットフォームによって異なります。 シグナルを発生しないかシグナルを発生するかにかかわらず、すべての NaN ビットパターンは上に示す NaN の範囲になければいけません。

パラメータ:
bits - 整数型
戻り値:
同じビットパターンを持つ float 浮動小数点値

compareTo

public int compareTo(Float anotherFloat)
2 つの Float オブジェクトを数値的に比較します。このメソッドによる比較は、Java 言語の数値比較演算子 (<, <=, ==, >= >) をプリミティブ float 値に適用した場合とは次の 2 つの点で異なります。 こうして、メソッドにより適用される Float オブジェクトの自然順序付けで、「equals との一貫性」が確保されます。

定義:
インタフェース Comparable<Float> 内の compareTo
パラメータ:
anotherFloat - 比較対象の Float
戻り値:
anotherFloat がこの Float と同じ数値の場合は値 0。この FloatanotherFloat より小さい数値の場合は 0 より小さい値。この FloatanotherFloat より大きい数値の場合は 0 より大きい値
導入されたバージョン:
1.2
関連項目:
Comparable.compareTo(Object)

compare

public static int compare(float f1,
                          float f2)
指定された 2 つの float 値を比較します。返される整数値の符号は、次の呼び出しで返される整数の符号と同じになります。  
    new Float(f1).compareTo(new Float(f2))
 

パラメータ:
f1 - 比較する最初の float
f2 - 比較する 2 番目の float
戻り値:
f1 の値が f2 と等しい場合は値 0f1 の値が f2 より小さい場合は 0 より小さい値、f1 の値が f2 より大きい場合は 0 より大きい値
導入されたバージョン:
1.4

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。