DoubleStream (java.util.stream API仕様 b128 非公式翻訳)

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

AutoCloseable, BaseStream<Double,DoubleStream>
```
public interface DoubleStream
extends BaseStream<Double,DoubleStream>
```
プリミティブのdoubleである要素の列であり、逐次集計処理および並列集計処理を備える。これはプリミティブのdoubleに特化したStreamである。
次の例はStreamとDoubleStreamを使った集計処理を示し、赤いウィジェットの重さの和を計算する。
```
 
    double sum = widgets.stream()
                        .filter(w -> w.getColor() == RED)
                        .mapToDouble(w -> w.getWeight())
                        .sum();
```
更なるストリームの仕様・処理・ストリームパイプライン・並列性についてはStreamのクラスドキュメントとjava.util.streamのパッケージドキュメントを参照せよ。

ネストされたクラスの概要

ネストされたクラス
修飾子とタイプ	インタフェースと説明
`static interface`	`DoubleStream.Builder` `DoubleStream`の可変なビルダ `StreamBuilder`はライフサイクルを持ち、要素を追加できる構築中段階から始まり、要素を追加できなくなる構築済段階に移行する。

メソッドの概要

All Methods Static Methods Instance Methods Abstract Methods Default Methods
修飾子とタイプ	メソッドと説明
`boolean`	`allMatch(DoublePredicate predicate)` このストリームの全ての要素が与えられた述語に適合するか返す。
`boolean`	`anyMatch(DoublePredicate predicate)` このストリームのある要素が与えられた述語に適合するか返す。
`OptionalDouble`	`average()` このストリームの算術平均を表す`OptionalDouble`、またはこのストリームが空ならば空の`OptionalDouble`いずれかの要素が`NaN`であるか、いずれかの時点での和が`NaN`である場合、平均値は`NaN`となる。
`Stream<Double>`	`boxed()` このストリームの要素を`Double`にボックス化した要素からなる`Stream`を返す。
`static DoubleStream.Builder`	`builder()` `DoubleStream`のビルダを返す。
`<R> R`	`collect(Supplier<R> supplier, ObjDoubleConsumer<R> accumulator, BiConsumer<R,R> combiner)` このストリームの要素に可変的簡約を実行する。
`static DoubleStream`	`concat(DoubleStream a, DoubleStream b)` ストリームの要素が、最初のストリームの全ての要素の後に2つ目のストリームの全ての要素を並べたような、遅延的に連結されたストリームを返す。
`long`	`count()` このストリームの要素数を返す。
`DoubleStream`	`distinct()` このストリームの要素のうち重複を除いた要素からなるストリームを返す。
`static DoubleStream`	`empty()` 空の逐次的`DoubleStream`を返す。
`DoubleStream`	`filter(DoublePredicate predicate)` このストリームの要素のうち、与えられた述語に適合する要素からなるストリームを返す。
`OptionalDouble`	`findAny()` このストリームのある要素を表す`OptionalDouble`、もしくはストリームが空であれば空の`OptionalDouble`を返す。
`OptionalDouble`	`findFirst()` このストリームの最初の要素を表す`OptionalDouble`、もしくはストリームが空であれば空の`OptionalDouble`を返す。
`DoubleStream`	`flatMap(DoubleFunction<? extends DoubleStream> mapper)` 与えられた写像関数をこのストリームの各要素に適用して生成したストリームの内容で各要素を置き換えた結果からなるストリームを返す。
`void`	`forEach(DoubleConsumer action)` このストリームの各要素にアクションを適用する。
`void`	`forEachOrdered(DoubleConsumer action)` このストリームの各要素にアクションを適用する。
`static DoubleStream`	`generate(DoubleSupplier s)` 各要素が`DoubleSupplier`によって生成される、逐次的な無限`Stream`を返す。
`static DoubleStream`	`iterate(double seed, DoubleUnaryOperator f)` 初期要素`seed`に対する関数`f`の繰り返しの適用によって生成された無限`DoubleStream`を返す。
`PrimitiveIterator.OfDouble`	`iterator()` このストリームの要素のイテレータを返す。
`DoubleStream`	`limit(long maxSize)` このストリームの要素からなり、長さが`maxSize`より長くならないように切り詰められたストリームを返す。
`DoubleStream`	`map(DoubleUnaryOperator mapper)` このストリームの要素に与えられた関数を適用した結果からなるストリームを返す。
`IntStream`	`mapToInt(DoubleToIntFunction mapper)` このストリームの要素に与えられた関数を適用した結果からなる`IntStream`を返す。
`LongStream`	`mapToLong(DoubleToLongFunction mapper)` このストリームの要素に与えられた関数を適用した結果からなる`LongStream`を返す。
`<U> Stream<U>`	`mapToObj(DoubleFunction<? extends U> mapper)` このストリームの要素に与えられた関数を適用した結果からなる、オブジェクトを値として持つ`Stream`を返す。
`OptionalDouble`	`max()` このストリームの最大要素を表す`OptionalDouble`、またはこのストリームが空ならば空の`OptionalDouble`もしストリームのいずれかの要素がNaNであれば、最大要素は`Double.NaN`となる。
`OptionalDouble`	`min()` このストリームの最小要素を表す`OptionalDouble`、またはこのストリームが空ならば空の`OptionalDouble`もしストリームのいずれかの要素がNaNであれば、最小要素は`Double.NaN`となる。
`boolean`	`noneMatch(DoublePredicate predicate)` このストリームのどの要素も与えられた述語に適合しないか返す。
`static DoubleStream`	`of(double... values)` 要素が指定された値であるような逐次的なストリームを返す。
`static DoubleStream`	`of(double t)` Returns a sequential `DoubleStream` containing a single element.
`DoubleStream`	`parallel()` 並列であり同等なストリームを返す。
`DoubleStream`	`peek(DoubleConsumer action)` このストリームの要素からなり、加えて結果のストリームから要素が消費されるごとにその要素にアクションを実行するストリームを返す。
`OptionalDouble`	`reduce(DoubleBinaryOperator op)` 与えられた結合的な累積関数を使って、このストリームの要素に簡約処理を実行して簡約された値があればそれを表す`OptionalDouble`を返す。
`double`	`reduce(double identity, DoubleBinaryOperator op)` 与えられた単位元と、結合的な累積関数を使って、このストリームの要素に簡約処理を実行して簡約された値を返す。
`DoubleStream`	`sequential()` 逐次的であり同等なストリームを返す。
`DoubleStream`	`skip(long n)` このストリームの`n`個の要素を取り除いた残りの要素からなるストリームを返す。
`DoubleStream`	`sorted()` このストリームの要素を、整列した結果からなるストリームを返す。
`Spliterator.OfDouble`	`spliterator()` このストリームの要素のスプリッテレータを返す。
`double`	`sum()` このストリームの要素の和を返す。
`DoubleSummaryStatistics`	`summaryStatistics()` このストリームの要素の各種概要情報を表す`DoubleSummaryStatistics`を返す。
`double[]`	`toArray()` このストリームの要素からなる配列を返す。

インタフェースから継承されたメソッド BaseStream
close, isParallel, onClose, unordered

- メソッドの詳細
  - filter
```
DoubleStream filter(DoublePredicate predicate)
```
    このストリームの要素のうち、与えられた述語に適合する要素からなるストリームを返す。
    これは中間処理である。
  - map
```
DoubleStream map(DoubleUnaryOperator mapper)
```
    このストリームの要素に与えられた関数を適用した結果からなるストリームを返す。
    これは中間処理である。
  - mapToObj
```
<U> Stream<U> mapToObj(DoubleFunction<? extends U> mapper)
```
    このストリームの要素に与えられた関数を適用した結果からなる、オブジェクトを値として持つStreamを返す。
    これは中間処理である。
  - mapToInt
```
IntStream mapToInt(DoubleToIntFunction mapper)
```
    このストリームの要素に与えられた関数を適用した結果からなるIntStreamを返す。
    これは中間処理である。
  - mapToLong
```
LongStream mapToLong(DoubleToLongFunction mapper)
```
    このストリームの要素に与えられた関数を適用した結果からなるLongStreamを返す。
    これは中間処理である。
  - flatMap
```
DoubleStream flatMap(DoubleFunction<? extends DoubleStream> mapper)
```
    与えられた写像関数をこのストリームの各要素に適用して生成したストリームの内容で各要素を置き換えた結果からなるストリームを返す。写像された各ストリームは、その内容がこのストリームに配置された後で閉じられる。(もし写像されたストリームがnullであれば、代わりに空のストリームが使われる)。
    これは中間処理である。
  - distinct
```
DoubleStream distinct()
```
    このストリームの要素のうち重複を除いた要素からなるストリームを返す。要素はDouble.compare(double, double)に従って比較される。
    これは状態を持つ中間処理である。
  - sorted
```
DoubleStream sorted()
```
    このストリームの要素を、整列した結果からなるストリームを返す。要素はDouble.compare(double, double)に従って比較される。
    これは状態を持つ中間処理である。
  - peek
```
DoubleStream peek(DoubleConsumer action)
```
    このストリームの要素からなり、加えて結果のストリームから要素が消費されるごとにその要素にアクションを実行するストリームを返す。
    これは中間処理である。
    並列ストリームパイプラインの場合、アクションは上流の処理から利用可能になった際に任意の時間と任意のスレッドで呼ばれる。もしアクションが共有状態を変更した場合、必要な同期を用意する必要がある。
  - limit
```
DoubleStream limit(long maxSize)
```
    このストリームの要素からなり、長さがmaxSizeより長くならないように切り詰められたストリームを返す。
    これは短絡的で状態を持つ中間処理である。
  - skip
```
DoubleStream skip(long n)
```
    このストリームのn個の要素を取り除いた残りの要素からなるストリームを返す。もしこのストリームがnより少ない要素を持つ場合、空のストリームが返される。
    これは状態を持つ中間処理である。
  - forEach
```
void forEach(DoubleConsumer action)
```
    このストリームの各要素にアクションを適用する。
    これは末端処理である。
    並列ストリームパイプラインの場合、この処理はストリームの出現順順序を尊重するとは限らない。そのようにしてしまうと並列処理の利点を犠牲にしてしまうためである。与えられた要素に対して、アクションはライブラリが選んだ任意の時間と任意のスレッドで実行される。もしアクションが共有状態を変更するならば、アクションは必要な同期処理を用意する責任を負う。
  - forEachOrdered
```
void forEachOrdered(DoubleConsumer action)
```
    このストリームの各要素にアクションを適用する。出現順順序が定義されているストリームに対しては各要素は出現順順序で実行されると保障する。
    これは末端処理である。
  - toArray
```
double[] toArray()
```
    このストリームの要素からなる配列を返す。
    これは末端処理である。
  - reduce
```
double reduce(double identity,
              DoubleBinaryOperator op)
```
    与えられた単位元と、結合的な累積関数を使って、このストリームの要素に簡約処理を実行して簡約された値を返す。これは次と等しい。
```
 
    double result = identity;
    for (double element : this stream)
        result = accumulator.applyAsDouble(result, element)
    return result;
```
    ただし逐次的に実行されるとは制約されていない。
    値identityは累積関数の単位元である必要がある。つまり、任意のxに対してaccumulator.apply(identity, x)はxと等しい。accumulator関数は結合的関数である必要がある。
    これは末端処理である。
  - reduce
```
OptionalDouble reduce(DoubleBinaryOperator op)
```
    与えられた結合的な累積関数を使って、このストリームの要素に簡約処理を実行して簡約された値があればそれを表すOptionalDoubleを返す。これは次と等しい。
```
 
    boolean foundAny = false;
    double result = null;
    for (double element : this stream) {
        if (!foundAny) {
            foundAny = true;
            result = element;
        }
        else
            result = accumulator.applyAsDouble(result, element);
    }
    return foundAny ?OptionalDouble.of(result) : OptionalDouble.empty();
```
    ただし逐次的に実行されるとは制約されていない。
    accumulator関数は結合的関数である必要がある。
    これは末端処理である。
  - collect
```
<R> R collect(Supplier<R> supplier,
              ObjDoubleConsumer<R> accumulator,
              BiConsumer<R,R> combiner)
```
    このストリームの要素に可変的簡約を実行する。可変的簡約は、簡約した値がArrayListなどの可変な結果コンテナであるものであり、結果を置き換えるのではなく結果の状態を変更して各要素を組み入れるような簡約である。これは次のコードと同じ結果を生成する。
```
 
    R result = supplier.get();
    for (double element : this stream)
        accumulator.accept(result, element);
    return result;
```
    reduce(double, DoubleBinaryOperator)のように、collect処理は追加の同期処理を必要とせずに並列化できる。
    これは末端処理である。
  - sum
```
double sum()
```
    このストリームの要素の和を返す。和は簡約の特別な場合である。もし浮動小数点の和が正確であれば、このメソッドは次と等価である。
```
 
    return reduce(0, Double::sum);
```
    しかし、浮動小数点の和は正確でないため、上記のコードはこのメソッドによる和の計算と等価とは限らない。
    いずれかの要素がNaNであるか、いずれかの時点での和がNaNである場合、和はNaNとなる。浮動小数点の和は入力値と加算演算子の順序の両方の関数である。このメソッドにおける加算の順序は実装が柔軟に計算結果の速度と精度を改善できるようあえて定義されていない。特に、このメソッドは補償付き和や他の技術を使って数値和の誤差の限度をdouble値の単純な和と比較して減らすように実装される場合がある。
    これは末端処理である。
  - min
```
OptionalDouble min()
```
    このストリームの最小要素を表すOptionalDouble、またはこのストリームが空ならば空のOptionalDoubleもしストリームのいずれかの要素がNaNであれば、最小要素はDouble.NaNとなる。数値比較演算子と異なり、このメソッドは負の零は正の零よりも真に小さいとみなす。これは簡約の特殊な場合であり、次のコードと等しい。
```
 
    return reduce(Double::min);
```
    これは末端処理である。
  - max
```
OptionalDouble max()
```
    このストリームの最大要素を表すOptionalDouble、またはこのストリームが空ならば空のOptionalDoubleもしストリームのいずれかの要素がNaNであれば、最大要素はDouble.NaNとなる。数値比較演算子と異なり、このメソッドは負の零は正の零よりも真に小さいとみなす。これは簡約の特殊な場合であり、次のコードと等しい。
```
 
    return reduce(Double::max);
```
    これは末端処理である。
  - count
```
long count()
```
    このストリームの要素数を返す。これは簡約の特殊な場合であり、次のコードと等しい。
```
 
    return mapToLong(e -> 1L).sum();
```
    これは末端処理である。
  - average
```
OptionalDouble average()
```
    このストリームの算術平均を表すOptionalDouble、またはこのストリームが空ならば空のOptionalDoubleいずれかの要素がNaNであるか、いずれかの時点での和がNaNである場合、平均値はNaNとなる。
    返される和は要素が出現する順番によって変わる場合がある。特に、このメソッドは平均を計算するために使われる数値和の誤差の限度を減らすための補償付き和や他の技術を使って実装される場合がある。
    平均は簡約の特別な場合である。
    これは末端処理である。
  - summaryStatistics
```
DoubleSummaryStatistics summaryStatistics()
```
    このストリームの要素の各種概要情報を表すDoubleSummaryStatisticsを返す。これは簡約の特別な場合である。
    これは末端処理である。
  - anyMatch
```
boolean anyMatch(DoublePredicate predicate)
```
    このストリームのある要素が与えられた述語に適合するか返す。結果を特定するのに必要でなければ全ての要素に対しては述語を評価しない。このストリームが空であれば、述語は評価されず、falseを返す。
    これは短絡的で状態を持つ末端処理である。
  - allMatch
```
boolean allMatch(DoublePredicate predicate)
```
    このストリームの全ての要素が与えられた述語に適合するか返す。結果を特定するのに必要でなければ全ての要素に対しては述語を評価しない。このストリームが空であれば、述語は評価されず、trueを返す。
    これは短絡的で状態を持つ末端処理である。
  - noneMatch
```
boolean noneMatch(DoublePredicate predicate)
```
    このストリームのどの要素も与えられた述語に適合しないか返す。結果を特定するのに必要でなければ全ての要素に対しては述語を評価しない。このストリームが空であれば、述語は評価されず、trueを返す。
    これは短絡的で状態を持つ末端処理である。
  - findFirst
```
OptionalDouble findFirst()
```
    このストリームの最初の要素を表すOptionalDouble、もしくはストリームが空であれば空のOptionalDoubleを返す。このストリームが出現順順序を持たなければ任意の要素が返される場合がある。
    これは短絡的で状態を持つ末端処理である。
  - findAny
```
OptionalDouble findAny()
```
    このストリームのある要素を表すOptionalDouble、もしくはストリームが空であれば空のOptionalDoubleを返す。
    これは短絡的で状態を持つ末端処理である。
    この処理の動作は明示的に非決定的であり、どの要素を選んでもよい。これにより並列実行時の性能を最大化できる。その際のコストは同じ情報源に対する複数回の呼び出しが同じ値を返さないことである(もし安定した結果を望むならば、代わりにfindFirst()を用いよ)。
  - boxed
```
Stream<Double> boxed()
```
    このストリームの要素をDoubleにボックス化した要素からなるStreamを返す。
    これは中間処理である。
  - sequential
```
DoubleStream sequential()
```
    インタフェースからコピーされた説明: BaseStream
    
    逐次的であり同等なストリームを返す。このストリームが既に逐次的であるため、または元のストリームの状態を逐次的であるように変更したため、このストリーム自身を返す場合がある。
    これは中間処理である。
    
    定義:
    
    sequential インタフェース内 BaseStream<Double,DoubleStream>
  - parallel
```
DoubleStream parallel()
```
    インタフェースからコピーされた説明: BaseStream
    
    並列であり同等なストリームを返す。このストリームが既に逐次的であるため、または元のストリームの状態を並列であるように変更したため、このストリーム自身を返す場合がある。
    これは中間処理である。
    
    定義:
    
    parallel インタフェース内 BaseStream<Double,DoubleStream>
  - iterator
```
PrimitiveIterator.OfDouble iterator()
```
    インタフェースからコピーされた説明: BaseStream
    
    このストリームの要素のイテレータを返す。
    これは末端処理である。
    
    定義:
    
    iterator インタフェース内 BaseStream<Double,DoubleStream>
  - spliterator
```
Spliterator.OfDouble spliterator()
```
    インタフェースからコピーされた説明: BaseStream
    
    このストリームの要素のスプリッテレータを返す。
    これは末端処理である。
    
    定義:
    
    spliterator インタフェース内 BaseStream<Double,DoubleStream>
  - builder
```
static DoubleStream.Builder builder()
```
    DoubleStreamのビルダを返す。
  - empty
```
static DoubleStream empty()
```
    空の逐次的DoubleStreamを返す。
  - of
```
static DoubleStream of(double t)
```
    Returns a sequential DoubleStream containing a single element.
  - of
```
static DoubleStream of(double... values)
```
    要素が指定された値であるような逐次的なストリームを返す。
  - iterate
```
static DoubleStream iterate(double seed,
                            DoubleUnaryOperator f)
```
    初期要素seedに対する関数fの繰り返しの適用によって生成された無限DoubleStreamを返す。seed, f(seed), f(f(seed))などからなるLongStreamを生成する。
    DoubleStreamの最初の要素(位置0)はseedによって与えられる。n > 0に対しては、位置nの要素はfを位置n - 1の要素に適用した結果である。
  - generate
```
static DoubleStream generate(DoubleSupplier s)
```
    各要素がDoubleSupplierによって生成される、逐次的な無限Streamを返す。定数のストリームや乱数のストリームなどを生成するのに向いている。
  - concat
```
static DoubleStream concat(DoubleStream a,
                           DoubleStream b)
```
    ストリームの要素が、最初のストリームの全ての要素の後に2つ目のストリームの全ての要素を並べたような、遅延的に連結されたストリームを返す。結果のストリームは両方の入力ストリームが順序を持ては順序を持ち、どちらかの入力ストリームが並列であれば並列である。結果のストリームが閉じられた場合、両方の入力ストリームを閉じるハンドラが呼び出される。

インタフェース DoubleStream

ネストされたクラスの概要

メソッドの概要

インタフェースから継承されたメソッド BaseStream

メソッドの詳細

filter

map

mapToObj

mapToInt

mapToLong

flatMap

distinct

sorted

peek

limit

skip

forEach

forEachOrdered

toArray

reduce

reduce

collect

sum

min

max

count

average

summaryStatistics

anyMatch

allMatch

noneMatch

findFirst

findAny

boxed

sequential

parallel

iterator

spliterator

builder

empty

of

of

iterate

generate

concat