functionalj.list.FuncListWithSegment Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of functionalj-core Show documentation
Show all versions of functionalj-core Show documentation
The module for FunctionalJ Core.
// ============================================================================
// Copyright (c) 2017-2021 Nawapunth Manusitthipol (NawaMan - http://nawaman.net).
// ----------------------------------------------------------------------------
// MIT License
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
// ============================================================================
package functionalj.list;
import static functionalj.list.AsFuncListHelper.funcListOf;
import static functionalj.list.FuncList.deriveFrom;
import java.util.Comparator;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.ToIntFunction;
import functionalj.list.doublelist.DoubleFuncList;
import functionalj.list.intlist.IntFuncList;
import functionalj.stream.IncompletedSegment;
import functionalj.stream.doublestream.DoubleStreamPlus;
import functionalj.stream.intstream.IntStreamPlus;
import functionalj.stream.markers.Sequential;
import lombok.val;
public interface FuncListWithSegment extends AsFuncList {
/**
* Segment the stream into sub stream with the fix length of count.
*
* Note:
*
* - The last portion may be shorter.
* - If the count is less than or equal to 0, an empty stream is return.
*
*
* @param count the element count of the sub stream.
**/
@Sequential
public default FuncList> segment(int count) {
val funcList = funcListOf(this);
return deriveFrom(funcList, stream -> stream.segment(count));
}
/**
* Create a stream of sub-stream which size is derived from the value.
*
* If the segmentSize function return 0,
* the value will be ignored.
*/
public default FuncList> segment(ToIntFunction segmentSize) {
val funcList = funcListOf(this);
return deriveFrom(funcList, stream -> stream.segment(segmentSize));
}
/** Segment the stream into sub stream whenever the start condition is true. */
@Sequential
public default FuncList> segmentWhen(Predicate startCondition) {
val funcList = funcListOf(this);
return deriveFrom(funcList, stream -> stream.segmentWhen(startCondition));
}
/** Segment the stream into sub stream starting the element after the precondition is true. */
@Sequential
public default FuncList> segmentAfter(Predicate endCondition) {
val funcList = funcListOf(this);
return deriveFrom(funcList, stream -> stream.segmentAfter(endCondition));
}
/**
* Segment the stream into sub stream
* starting when the start condition is true
* and ending when the end condition is true
* -- both inclusively.
*
* Note: this method will include the last sub stream
* even if the end condition is never been true before the stream ended.
*
* @param startCondition the condition to start the sub stream
* @param endCondition the condition to end the sub stream
*/
@Sequential
public default FuncList> segmentBetween(
Predicate startCondition,
Predicate endCondition) {
val funcList = funcListOf(this);
return deriveFrom(funcList, stream -> stream.segmentBetween(startCondition, endCondition));
}
/**
* Segment the stream into sub stream
* starting when the start condition is true
* and ending when the end condition is true
* -- both inclusively.
*
* @param startCondition the condition to start the sub stream
* @param endCondition the condition to end the sub stream
* @param includeIncompletedSegment specifying if the incomplete segment at the end should be included.
*/
@Sequential
public default FuncList> segmentBetween(
Predicate startCondition,
Predicate endCondition,
IncompletedSegment incompletedSegment) {
val funcList = funcListOf(this);
return deriveFrom(funcList, stream -> stream.segmentBetween(startCondition, endCondition, incompletedSegment));
}
/**
* Segment the stream into sub stream
* starting when the start condition is true
* and ending when the end condition is true
* -- both inclusively.
*
* @param startCondition the condition to start the sub stream
* @param endCondition the condition to end the sub stream
* @param includeIncompletedSegment specifying if the incomplete segment at the end should be included.
*/
public default FuncList> segmentBetween(
Predicate startCondition,
Predicate endCondition,
boolean includeIncompletedSegment) {
val funcList = funcListOf(this);
return deriveFrom(funcList, stream -> stream.segmentBetween(startCondition, endCondition, includeIncompletedSegment));
}
//-- segmentByPercentiles --
/** Split the stream into segment based on the given percentiles. **/
public default FuncList> segmentByPercentiles(int ... percentiles) {
val percentileList = IntStreamPlus.of(percentiles).mapToDouble().toImmutableList();
return segmentByPercentiles(percentileList);
}
/** Split the stream into segment based on the given percentiles. **/
public default FuncList> segmentByPercentiles(double ... percentiles) {
val percentileList = DoubleStreamPlus.of(percentiles).toImmutableList();
return segmentByPercentiles(percentileList);
}
/** Split the stream into segment based on the given percentiles. **/
public default FuncList> segmentByPercentiles(IntFuncList percentiles) {
val list = streamPlus().sorted().toImmutableList();
return FuncListHelper.segmentByPercentiles(list, percentiles.mapToDouble());
}
/** Split the stream into segment based on the given percentiles. **/
public default FuncList> segmentByPercentiles(DoubleFuncList percentiles) {
val list = streamPlus().sorted().toImmutableList();
return FuncListHelper.segmentByPercentiles(list, percentiles);
}
/** Split the stream into segment based on the given percentiles. **/
public default > FuncList> segmentByPercentiles(
Function mapper,
int ... percentiles) {
val percentileList = IntStreamPlus.of(percentiles).mapToDouble().toImmutableList();
return segmentByPercentiles(mapper, percentileList);
}
/** Split the stream into segment based on the given percentiles. **/
public default FuncList> segmentByPercentiles(
Function mapper,
Comparator comparator,
int ... percentiles) {
val percentileList = IntStreamPlus.of(percentiles).mapToDouble().toImmutableList();
return segmentByPercentiles(mapper, comparator, percentileList);
}
/** Split the stream into segment based on the given percentiles. **/
public default > FuncList> segmentByPercentiles(
Function mapper,
double ... percentiles) {
val percentileList = DoubleStreamPlus.of(percentiles).toImmutableList();
return segmentByPercentiles(mapper, percentileList);
}
/** Split the stream into segment based on the given percentiles. **/
public default FuncList> segmentByPercentiles(
Function mapper,
Comparator comparator,
double ... percentiles) {
val percentileList = DoubleStreamPlus.of(percentiles).toImmutableList();
return segmentByPercentiles(mapper, comparator, percentileList);
}
/** Split the stream into segment based on the given percentiles. **/
public default > FuncList> segmentByPercentiles(
Function mapper,
IntFuncList percentiles) {
val list = streamPlus().sortedBy(mapper).toImmutableList();
return FuncListHelper.segmentByPercentiles(list, percentiles.mapToDouble());
}
/** Split the stream into segment based on the given percentiles. **/
public default FuncList> segmentByPercentiles(
Function mapper,
Comparator comparator,
IntFuncList percentiles) {
val list = streamPlus().sortedBy(mapper, comparator).toImmutableList();
return FuncListHelper.segmentByPercentiles(list, percentiles.mapToDouble());
}
/** Split the stream into segment based on the given percentiles. **/
public default > FuncList> segmentByPercentiles(
Function mapper,
DoubleFuncList percentiles) {
val list = streamPlus().sortedBy(mapper).toImmutableList();
return FuncListHelper.segmentByPercentiles(list, percentiles);
}
/** Split the stream into segment based on the given percentiles. **/
public default FuncList> segmentByPercentiles(
Function mapper,
Comparator comparator,
DoubleFuncList percentiles) {
val list = streamPlus().sortedBy(mapper, comparator).toImmutableList();
return FuncListHelper.segmentByPercentiles(list, percentiles);
}
}