Package ai.timefold.solver.core.preview.api.neighborhood.stream.enumerating

Interface BiEnumeratingStream<Solution_,A,B>

All Superinterfaces:

EnumeratingStream

All Known Implementing Classes:

AbstractBiEnumeratingStream, AftBridgeBiEnumeratingStream, JoinBiEnumeratingStream

@NullMarked
public interface BiEnumeratingStream<Solution_,A,B>
extends EnumeratingStream

Method Summary

Modifier and Type	Method	Description
BiEnumeratingStream<Solution_,A,B>	distinct()	As defined by UniEnumeratingStream.distinct().
BiEnumeratingStream<Solution_,A,B>	filter(BiNeighborhoodsPredicate<Solution_,A,B> filter)	Exhaustively test each fact against the BiNeighborhoodsPredicate and match if BiNeighborhoodsPredicate.test(SolutionView, Object, Object) returns true.
<ResultA_> UniEnumeratingStream<Solution_,ResultA_>	map(BiNeighborhoodsMapper<Solution_,A,B,ResultA_> mapping)	As defined by UniEnumeratingStream.map(UniNeighborhoodsMapper).
<ResultA_, ResultB_> BiEnumeratingStream<Solution_,ResultA_,ResultB_>	map(BiNeighborhoodsMapper<Solution_,A,B,ResultA_> mappingA, BiNeighborhoodsMapper<Solution_,A,B,ResultB_> mappingB)	As defined by map(BiNeighborhoodsMapper), only resulting in BiEnumeratingStream.

Method Details

filter

BiEnumeratingStream<Solution_,A,B> filter(BiNeighborhoodsPredicate<Solution_,A,B> filter)

Exhaustively test each fact against the BiNeighborhoodsPredicate and match if BiNeighborhoodsPredicate.test(SolutionView, Object, Object) returns true.

map

<ResultA_> UniEnumeratingStream<Solution_,ResultA_> map(BiNeighborhoodsMapper<Solution_,A,B,ResultA_> mapping)

As defined by UniEnumeratingStream.map(UniNeighborhoodsMapper).

Use with caution, as the increased memory allocation rates coming from tuple creation may negatively affect performance.

Type Parameters:

ResultA_ - the type of the only fact in the resulting UniEnumeratingStream's tuple

Parameters:

mapping - function to convert the original tuple into the new tuple

map

<ResultA_,
ResultB_>
BiEnumeratingStream<Solution_,ResultA_,ResultB_> map(BiNeighborhoodsMapper<Solution_,A,B,ResultA_> mappingA,
 BiNeighborhoodsMapper<Solution_,A,B,ResultB_> mappingB)

As defined by map(BiNeighborhoodsMapper), only resulting in BiEnumeratingStream.

Type Parameters:

ResultA_ - the type of the first fact in the resulting BiEnumeratingStream's tuple

ResultB_ - the type of the first fact in the resulting BiEnumeratingStream's tuple

Parameters:

mappingA - function to convert the original tuple into the first fact of a new tuple

mappingB - function to convert the original tuple into the second fact of a new tuple

distinct

BiEnumeratingStream<Solution_,A,B> distinct()

As defined by UniEnumeratingStream.distinct().