java.lang
クラス Float

java.lang.Object
  |
  +--java.lang.Number
        |
        +--java.lang.Float

public final class Float

extends Number

implements Comparable

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

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

導入されたバージョン:

JDK1.0

関連項目:

直列化された形式

フィールドの概要

static float	MAX_VALUE float 型の正の最大値です。
static float	MIN_VALUE float 型の正の最小値です。
static float	NaN float 型の非数 (NaN) 値です。
static float	NEGATIVE_INFINITY float 型の負の無限大です。
static float	POSITIVE_INFINITY float 型の正の無限大です。
static Class	TYPE float プリミティブ型を表す Class オブジェクトです。

コンストラクタの概要

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

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

Float(String s)
文字列で表される float 型の浮動小数点値を表す、新しく割り当てられた Float オブジェクトを構築します。

メソッドの概要

byte	byteValue() この Float の値を byte 型として返します (byte 型へのキャストによる)。
int	compareTo(Float anotherFloat) 2 つの Float オブジェクトを数値的に比較します。
int	compareTo(Object o) この Float を別のオブジェクトと比較します。
double	doubleValue() この Float オブジェクトの double 値を返します。
boolean	equals(Object obj) このオブジェクトをほかのオブジェクトと比較します。
static int	floatToIntBits(float value) 単精度 float 値のビット表現を返します。
float	floatValue() この Float オブジェクトの float 値を返します。
int	hashCode() この Float オブジェクトのハッシュコードを返します。
static float	intBitsToFloat(int bits) 指定されたビット表現と対応する単精度 float 値を返します。
int	intValue() この Float の int 値を返します (int 型へのキャストによる)。
boolean	isInfinite() この Float 値の絶対値が無限量である場合に true を返します。
static boolean	isInfinite(float v) 指定された数値の絶対値が無限量である場合に true を返します。
boolean	isNaN() この Float 値が非数 (NaN) である場合に true を返します。
static boolean	isNaN(float v) 指定された数値が特別な非数 (NaN) である場合に true を返します。
long	longValue() この Float の long 値を返します (long 型へのキャストによる)。
static float	parseFloat(String s) Double クラスの valueOf メソッドを実行した場合と同様に、指定された String が表す値に初期化された新しい float 値を返します。
short	shortValue() この Float の値を short 型として返します (short 型へのキャストによる)。
String	toString() この Float オブジェクトの String 表現を返します。
static String	toString(float f) 指定された float 値の String 表現を返します。
static Float	valueOf(String s) 指定された String で表現される浮動小数点値を返します。

クラス 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 型の正の最大値です。Float.intBitsToFloat(0x7f7fffff) が返す値と同じです。

MIN_VALUE

public static final float MIN_VALUE

float 型の正の最小値です。Float.intBitsToFloat(0x1) が返す値と同じです。

TYPE

public static final Class 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 値の String 表現を返します。引数は、次のように読み込み可能な文字列に変換されます。次の説明に記載した文字、および文字列内の文字はすべて ASCII 文字です。

• 引数が NaN であれば、変換後の文字列は "NaN"
• それ以外の場合、変換後の文字列は引数の符号および絶対値を表す。符号が負の場合、変換後の文字列の最初の文字は '-' ('-') である。符号が正の場合、変換後の文字列に符号の文字は表示されない。絶対値を表す m の扱いは、以下のとおり
  • m が無限大の場合は、"Infinity" という文字列で表す。つまり、正の無限大は "Infinity"、負の無限大は "-Infinity" となる
  • m がゼロの場合は、"0.0" という文字列で表す。つまり、負のゼロは"-0.0"、正のゼロは "0.0" となる
  • m が 10^-3 以上で 10⁷ 未満の場合は、m の整数部として先頭にゼロの付かない 10 進数、小数点 '.' (.)、m の小数部を表す 1 桁以上の 10 進数がこの順で並んだ形で表現される
  • m が 10^-3 未満、あるいは 10⁷ を超える場合は、浮動小数点表記法で表現する。たとえば、n が 10ⁿ<=m<1 に該当する一意の整数、a が 1<a<10 となるような、m と 10ⁿ の数学的に正確な商とする。この場合、絶対値は 1 つの引数をとるメソッド Integer.toString(int) から返されたとおり、a の整数部である 1 桁の 10 進数、'.' (.)、a の小数部を表す 10 進数、文字 'E' (E)、n を表す 10 進整数がこの順で並んだ形で表現される

m あるいは a の小数部を表す桁数は、1 桁以上でなければなりませんが、必要に応じて float 型の隣接値から引数を一意に識別するために最低限必要な桁数にしてください。たとえば、ゼロでない有限の引数 f を指定してこのメソッドで生成した 10 進数表記を x とします。この場合、f は x の float 型最近似値でなければなりません。あるいは、float 型の 2 つの値が均等に x に近似している場合であれば、f は 2 つの値のどちらかでなければならず、f の有効な最下位ビットは 0 でなければなりません。

パラメータ:

f - 変換される float 値

戻り値:

引数の文字列表現

valueOf

public static Float valueOf(String s)
                     throws NumberFormatException

指定された String で表現される浮動小数点値を返します。文字列 s を浮動小数点値の文字列表現と解釈して、その値を表す Float オブジェクトを作成して返します。

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

文字列 s の先頭と末尾にある空白文字は無視されます。s の残りの部分が、次の字句構文規則に従って FloatValue を構成します。

 FloatValue:
 
          Signopt FloatingPointLiteral
 

ここで Sign、および FloatingPointLiteral は Java 言語仕様の 3.10.2 での定義に従います。FloatValue の形式でない場合は、NumberFormatException がスローされます。そうでない場合は、通常の浮動小数点表示形式で正確な 10 進数を表していると見なされます。この正確な 10 進数は、概念上は無限精度のバイナリ値に変換されてから、IEE 754 の浮動小数点計算法による通常の最近似値丸め法に従って float 型に丸められます。

パラメータ:

s - 解析対象の文字列

戻り値:

新しく構築された Float。引数 String で表される値に初期化されている

例外:

NumberFormatException - 文字列が解析可能な数値を含まない場合

parseFloat

public static float parseFloat(String s)
                        throws NumberFormatException

Double クラスの valueOf メソッドを実行した場合と同様に、指定された String が表す値に初期化された新しい float 値を返します。

パラメータ:

s - 解析対象の文字列

戻り値:

引数の文字列が表す float 値

例外:

NumberFormatException - 文字列が解析可能な float を含まない場合

導入されたバージョン:

JDK1.2

関連項目:

Double.valueOf(String)

isNaN

public static boolean isNaN(float v)

指定された数値が特別な非数 (NaN) である場合に true を返します。

パラメータ:

v - テスト対象の値

戻り値:

引数が NaN である場合は true、そうでない場合は false

isInfinite

public static boolean isInfinite(float v)

指定された数値の絶対値が無限量である場合に true を返します。

パラメータ:

v - テスト対象の値

戻り値:

引数が無限大または無限小である場合は true、そうでない場合は false

isNaN

public boolean isNaN()

この Float 値が非数 (NaN) である場合に true を返します。

戻り値:

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

isInfinite

public boolean isInfinite()

この Float 値の絶対値が無限量である場合に true を返します。

戻り値:

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

toString

public String toString()

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

戻り値:

このオブジェクトの String 表現

オーバーライド:

クラス Object 内の toString

関連項目:

toString(float)

byteValue

public byte byteValue()

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

オーバーライド:

クラス Number 内の byteValue

導入されたバージョン:

JDK1.1

shortValue

public short shortValue()

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

オーバーライド:

クラス Number 内の shortValue

導入されたバージョン:

JDK1.1

intValue

public int intValue()

この Float の int 値を返します (int 型へのキャストによる)。

戻り値:

このオブジェクトが表す float 値を int 型に変換した値

オーバーライド:

クラス Number 内の intValue

longValue

public long longValue()

この Float の long 値を返します (long 型へのキャストによる)。

戻り値:

このオブジェクトが表す float 値を long 型に変換した値

オーバーライド:

クラス Number 内の longValue

floatValue

public float floatValue()

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

戻り値:

このオブジェクトが表す float 値

オーバーライド:

クラス Number 内の floatValue

doubleValue

public double doubleValue()

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

戻り値:

このオブジェクトが表す float 値を double 型に変換した値

オーバーライド:

クラス Number 内の doubleValue

hashCode

public int hashCode()

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

戻り値:

このオブジェクトのハッシュコード値

オーバーライド:

クラス Object 内の hashCode

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 つあります。

• f1 および f2 の両方が Float.NaN を表す場合は、Float.NaN==Float.NaN の値が false であっても、equals メソッドは true を返す
• f1 が +0.0f を表し、f2 が -0.0f を表す場合、あるいは f1 が -0.0f を表し、f2 が +0.0f を表す場合は、0.0f==-0.0f の値が true であっても、equal メソッドの結果は false になる

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

戻り値:

2 つのオブジェクトが等しい場合は true、そうでない場合は false

オーバーライド:

クラス Object 内の equals

関連項目:

floatToIntBits(float)

floatToIntBits

public static int floatToIntBits(float value)

単精度 float 値のビット表現を返します。結果は、IEEE 754 浮動小数点「単精度」ビット配列に従った、浮動小数点表現の引数になります。

• ビット 31 (マスク 0x80000000 で選択されるビット) は、浮動小数点数の符号を表す
• ビット 30 〜 23 (マスク 0x7f800000 で選択されるビット) は、指数を表す
• ビット 22 〜 0 (マスク 0x007fffff で選択されるビット) は、浮動小数点数の有効数字 (仮数) を表す
• 引数が正の無限大の場合は、0x7f800000 が返される
• 引数が負の無限大の場合は、0xff800000 が返される
• 引数が NaN の場合は、0x7fc00000 が返される

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

パラメータ:

value - 浮動小数点値

戻り値:

浮動小数点値を表すビット

intBitsToFloat

public static float intBitsToFloat(int bits)

指定されたビット表現と対応する単精度 float 値を返します。引数は、IEEE 754 浮動小数点「単精度」ビット配列に従った浮動小数点表現と見なされます。

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

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

引数が 0x7f800001 〜 0x7fffffff の範囲、あるいは 0xff800001 〜 0xffffffff の範囲にある場合は、NaN が返されます。IEEE 754 によるすべての NaN 値は、事実上、Java 言語では NaN という単一の値にまとめられます。

そのほかの場合では、s、e、および 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·2^e-150 の値と等しくなります。

パラメータ:

bits - 整数値

戻り値:

同じビットパターンによる、単精度の浮動小数点値

compareTo

public int compareTo(Float anotherFloat)

2 つの Float オブジェクトを数値的に比較します。このメソッドによる比較は、Java 言語の数値比較演算子 (<, <=, ==, >= >) をプリミティブ float 値に適用した場合とは次の 2 つの点で異なります。

• このメソッドでは、Float.NaN は自分自身に等しく、Float.POSITIVE_INFINITY を含むほかのすべての float 値より大きいと見なされる
• このメソッドでは、 0.0f は -0.0f より大きいと見なされる

これにより、このメソッドから動作を継承する Float.compareTo(Object) では、Comparable.compareTo の一般的な規約に従い、Float での自然順序付けが「全体的」になります。

パラメータ:

anotherFloat - 比較対象の Float

戻り値:

anotherFloat がこの Float と同じ数値の場合は値 0。Float が anotherFloat より小さい数値の場合は 0 より小さい値。Float が anotherFloat より大きい数値の場合は 0 より大きい値

導入されたバージョン:

JDK1.2

関連項目:

Comparable.compareTo(Object)

compareTo

public int compareTo(Object o)

この Float を別のオブジェクトと比較します。指定された Object が Float の場合、この関数の動作は compareTo(Float) と同じです。それ以外の場合は、ClassCastException がスローされます。これは、Float の比較は Float 同士でしか行えないためです。

定義:

インタフェース Comparable 内の compareTo

パラメータ:

o - 比較対象の Object

戻り値:

引数がこの Float と同じ数値の場合は値 0。引数がこの Float より大きい数値の場合は 0 より小さい値。引数がこの Float より小さい数値の場合は 0より大きい値

例外:

ClassCastException - 引数が Float でない場合

導入されたバージョン:

JDK1.2

関連項目:

Comparable