compact1, compact2, compact3

java.util

クラスDoubleSummaryStatistics

java.lang.Object

java.util.DoubleSummaryStatistics

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

DoubleConsumer

public class DoubleSummaryStatistics
extends Object
implements DoubleConsumer

カウント数、最小、最大、合計、平均などの統計情報を収集するための状態オブジェクト。

このクラスは、streamsを扱う(必須ではないが)ために作られたものです。たとえば、次を使って、doubleのストリームに関するサマリー統計を計算することができます。

 
 DoubleSummaryStatistics stats = doubleStream.collect(DoubleSummaryStatistics::new,
                                                      DoubleSummaryStatistics::accept,
                                                      DoubleSummaryStatistics::combine);
 

DoubleSummaryStatisticsは、streamのリダクション・ターゲットとして使用できます。たとえば、

 
 DoubleSummaryStatistics stats = people.stream()
     .collect(Collectors.summarizingDouble(Person::getWeight));

これは、単一パスで、人数だけでなく、その体重の最小値、最大値、合計、および平均値も計算します。

実装上の注意:

この実装はスレッドに対して安全ではありません。ただし、並列ストリームでCollectors.toDoubleStatistics()を使用することは安全です。これは、Stream.collect()の並列実装によって、安全かつ効率的な並列実行に必要な結果のパーティション化、隔離、およびマージが行われるからです。

導入されたバージョン:

1.8

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
DoubleSummaryStatistics() カウントがゼロ、合計がゼロ、最小値がDouble.POSITIVE_INFINITY、最大値がDouble.NEGATIVE_INFINITY、平均値がゼロである空のインスタンスを構築します。

メソッドのサマリー

修飾子と型	メソッドと説明
void	accept(double value) 別の値をサマリー情報に記録します。
void	combine(DoubleSummaryStatistics other) もう一方のDoubleSummaryStatisticsの状態をこれに統合します。
double	getAverage() 記録された値の算術平均を返します。値が記録されていない場合は0を返します。
long	getCount() 記録された値のカウントを返します。
double	getMax() 記録された最大値を返します。記録された値がNaNだった場合はDouble.NaNを返し、値が記録されなかった場合はDouble.NEGATIVE_INFINITYを返します。
double	getMin() 記録された最小値を返します。記録された値がNaNだった場合はDouble.NaNを返し、値が記録されなかった場合はDouble.POSITIVE_INFINITYを返します。
double	getSum() 記録された値の合計を返します。値が記録されていない場合は0を返します。
String	toString() オブジェクトの文字列表現を返します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

インタフェースjava.util.function.DoubleConsumerから継承されたメソッド

andThen

コンストラクタの詳細

DoubleSummaryStatistics

public DoubleSummaryStatistics()

カウントがゼロ、合計がゼロ、最小値がDouble.POSITIVE_INFINITY、最大値がDouble.NEGATIVE_INFINITY、平均値がゼロである空のインスタンスを構築します。

メソッドの詳細

accept

public void accept(double value)

別の値をサマリー情報に記録します。

定義:

accept、インタフェース: DoubleConsumer

パラメータ:

value - 入力値

combine

public void combine(DoubleSummaryStatistics other)

もう一方のDoubleSummaryStatisticsの状態をこれに統合します。

パラメータ:

other - もう一方のDoubleSummaryStatistics

例外:

NullPointerException - otherがnullである場合

getCount

public final long getCount()

記録された値のカウントを返します。

戻り値:

値の数

getSum

public final double getSum()

記録された値の合計を返します。値が記録されていない場合は0を返します。記録された値のいずれかがNaNであるか、合計がいずれかの時点でNaNになる場合、合計はNaNになります。

浮動小数点合計の値は、入力値と加算操作順序の両方の関数になります。このメソッドの加算操作の順序は意図的に未定義になっていますが、それは、実装が計算結果の速度や精度を柔軟に改善できるようにするためです。特に、このメソッドを補正加算などのテクニックを使って実装すれば、double値の単純な合計に比べ、数値合計の誤り限界を減らせます。

APIの注:

値を大きさの絶対値の昇順にソートすると、結果の精度が改善される傾向があります。

戻り値:

値の合計。値がない場合はゼロ

getMin

public final double getMin()

記録された最小値を返します。記録された値がNaNだった場合はDouble.NaNを返し、値が記録されなかった場合はDouble.POSITIVE_INFINITYを返します。数値比較演算子とは異なり、このメソッドは負のゼロが厳密には正のゼロよりも小さいと見なします。

戻り値:

記録された最小値。記録された値のいずれかがNaNだった場合はDouble.NaN。値が記録されなかった場合はDouble.POSITIVE_INFINITY

getMax

public final double getMax()

記録された最大値を返します。記録された値がNaNだった場合はDouble.NaNを返し、値が記録されなかった場合はDouble.NEGATIVE_INFINITYを返します。数値比較演算子とは異なり、このメソッドは負のゼロが厳密には正のゼロよりも小さいと見なします。

戻り値:

記録された最大値。記録された値のいずれかがNaNだった場合はDouble.NaN。値が記録されなかった場合はDouble.NEGATIVE_INFINITY

getAverage

public final double getAverage()

記録された値の算術平均を返します。値が記録されていない場合は0を返します。記録された値のいずれかがNaNであるか、合計がいずれかの時点でNaNになる場合、平均はコードNaNになります。

返される平均は、値が記録されている順序によって変わる可能性があります。このメソッドを補正加算などのテクニックを使って実装すれば、平均の計算に使用される数値合計の誤り限界を減らせます。

APIの注:

値を大きさの絶対値の昇順にソートすると、結果の精度が改善される傾向があります。

戻り値:

値の算術平均。値がない場合はゼロ

toString

public String toString()

オブジェクトの文字列表現を返します。一般に、toStringメソッドは、このオブジェクトを「テキストで表す」文字列を返します。この結果は、人間が読める簡潔で有益な情報であるべきです。すべてのサブクラスで、このメソッドをオーバーライドすることをお薦めします。

クラスObjectのtoStringメソッドは、オブジェクトがインスタンスになっている元のクラスの名前、アットマーク文字「@」、およびオブジェクトのハッシュ・コードの符号なし16進数表現から構成される文字列を返します。つまり、このメソッドは次の値と等しい文字列を返します。

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

デバッグに適しているこのオブジェクトの空ではない文字列表現を返します。正確な表示フォーマットは未指定であり、実装とバージョンの間で異なることがあります。

オーバーライド:

toString、クラス: Object

戻り値:

このオブジェクトの文字列表現