Change Log

v0.14.0

Implement movingGeometricMean(), movingGeometricMeanBy(), runningGeometricMean(), and runningGeometricMeanBy().
Implement filterNotNull(), which filters out null values from the input stream and is useful for lining up JSpecify annotations (from nullable to non-nullable).
Fix bug in movingProduct() and movingProductBy() where zero values were incorrectly handled. Addresses #184.
Change CrossGatherer, TypeFilteringGatherer, and FlattenSingleOrFail to use Greedy integrators.
Thank you to @Riggs333 for contributing code cleanups, making comparisons in FrequencyGatherer easier to understand!
Thank you to @Riggs333 for contributing changes to tests to use AssertJ’s type-specific exception assertions, which clarifies the intent of the code!

Behavior change: All “moving” gatherers will now include all calculated values by default, even when the full lookback window has not been reached.
- To turn this behavior off, use excludePartialValues().
- Previously, partial results were suppressed and turned on via includePartialValues().
- This affects movingMax(), movingMaxBy(), movingMin(), movingMinBy(), movingMedian(), movingMedianBy(), movingProduct(), movingProductBy(), movingSum(), movingSumBy(), simpleMovingAverage(), and simpleMovingAverageBy()
Implement uniquelyOccurringBy() to limit the stream to uniquely occurring elements as measured by the given function
Implement movingMedian() and movingMedianBy()
Implement runningMedian() and runningMedianBy()
Implement movingMax(), movingMaxBy(), movingMin(), and movingMinBy()
Implement runningMax(), runningMaxBy(), runningMin(), and runningMinBy()
Fixes to documentation

Fix and document behavior of window() when there are multiple partial groupings at the end. Addresses #135, thanks @paulk-asert!
Implement exponential moving averages with exponentialMovingAverageWithAlpha(), exponentialMovingAverageWithAlphaBy(),exponentialMovingAverageWithPeriod(), and exponentialMovingAverageWithPeriodBy().
Change index to be an int rather than a long in filterIndexed(), foldIndexed(), mapIndexed(), peekIndexed(), scanIndexed() and withIndex(). Addresses #140.
Optimize rotate(Left) to store a minimal set of elements instead of the entire stream. Addresses #141, thanks @paulk-asert!

Upgrade the minimum Java version from 23 to 24
Implement mapIndexed() to perform a mapping operation given the element being mapped and its zero-based index
Implement peekIndexed() to peek at each element and its zero-based index
Implement sampleFixedSize() to randomly sample a fixed number of elements from a stream
Implement samplePercentage() to randomly sample a percentage of the stream elements
Rename IndexedValue to WithIndex, for consistency (matching WithCount and WithOriginal)

Implement filterInstanceOf() to filter a stream by type more easily. Addresses #86, thanks @nipafx.
Implement groupOrdered(), and groupOrderedBy() to appropriately group elements in the input stream to lists in the output stream. Addresses #88, thanks @nipafx.
Implement ensureOrdered() and ensureOrderedBy() to ensure the given stream meets an ordering criteria, or fail exceptionally otherwise
Implement filterOrdered() and filterOrderedBy() to remove non-ordered elements from the input stream
Implement window() to provide more options to windowing functions, namely - ability to specify size, how many to skip each time, and whether to include partial windows
Implement repeat(n) and repeatInfinitely() to repeatedly emit the input stream to the output stream
Implement rotate(n) rotate the stream either left or right (consumes entire stream)
Renamed everyNth(n) to takeEveryNth(n) and added dropEveryNth(n) for completeness
Renamed filterWithIndex() to filterIndexed() to match other indexing Gatherers
Renamed cross() to crossWith() for consistency
Renamed interleave() to interleaveWith() for consistency
Renamed grouping() to group() and groupingBy() to groupBy() for consistency
Renamed last() to takeLast() to match dropLast()

Add support for orElse() and orElseEmpty() on size-based gatherers to provide a non-exceptional output stream
Implement everyNth() to get every n^th element from the stream
Implement uniquelyOccurring() to emit stream elements that occur a single time
Implement takeUntil() to take from a stream until a predicate is met, including the first element that matches the predicate
Implement foldIndexed() to perform a fold along with the index of each element
Implement scanIndexed() to perform a scan along with the index of each element
Implement intersperse() to put the given element between each element of the stream
Implement cross(iterable), cross(iterator), and cross(stream) to combine elements in the input stream with the given source of elements

Use greedy integrators where possible (Addresses #57)
Add JSpecify annotations for static analysis
Implement orderByFrequencyAscending() and orderByFrequencyDescending()
Implement movingProduct() and movingProductBy()
Implement movingSum() and movingSumBy()
Remove maxBy(fn) and minBy(fn), can be done with JDK methods trivially
Rename exactSize() to sizeExactly()
Implement sizeLessThan(), sizeLessThanOrEqualTo(), sizeGreaterThan(), and sizeGreaterThanOrEqualTo()
API Style - Functions, when used as arguments, should come last for consistency and to play nice with Kotlin (Addresses #64)

Implement dropLast(n)
Implement grouping() and groupingBy(fn)
Add support for zipWith(iterable) and zipWith(iterator)
- With support for:
- argumentWhenSourceLonger(fn)
- sourceWhenArgumentLonger(fn)
- nullArgumentWhenSourceLonger()
- nullSourceWhenArgumentLonger()
Add support for interleave(iterable) and interleave(iterator)
- With support for:
- appendLonger()
- appendArgumentIfLonger()
- appendSourceIfLonger()

Implement reverse() - Cause a stream to be emitted in reverse (stores entire stream in memory)
Implement maxBy(fn) and minBy(fn) - Finds the single maximum or minimum value in a stream as defined by the function given (stores entire stream in memory)
Implement exactSize(n) - Ensures a stream is precisely n elements long or throws an IllegalStateException (stores entire stream in memory)

Implement shuffle() and shuffle(RandomGenerator)
Implement filterWithIndex()
Implement runningProduct() and runningProductBy()
Implement runningSum() and runningSumBy()
Remove concat() implementation (the JDK has this)
Remove withIndexStartingAt() from filterWithIndex(), not sure if this is a real use case.