two-colored-range/me.thorny.twoColoredRange.rangeUtils

Package-level declarations

Types

ClosedRangeFactory

open class ClosedRangeFactory<BoundType : Comparable<BoundType>> : RangeFactory<BoundType>

Default range factory, it should work for any BoundType.

IntRangeFactory

object IntRangeFactory : RangeFactory<Int>

Range factory for IntRange.

LongRangeFactory

object LongRangeFactory : RangeFactory<Long>

Range factory for LongRange.

interface RangeFactory<BoundType : Comparable<BoundType>>

Factory for ranges.

Functions

fun <BoundType : Comparable<BoundType>> ClosedRange<BoundType>.containsRange(other: ClosedRange<BoundType>): Boolean

Checks if other range is entirely inside this.

intersectsRange

fun <BoundType : Comparable<BoundType>> ClosedRange<BoundType>.intersectsRange(other: ClosedRange<BoundType>): Boolean

Checks if other range intersects this.

fun <BoundType : Comparable<BoundType>> ClosedRange<BoundType>.joinedByRange(other: ClosedRange<BoundType>, rangeFactory: RangeFactory<BoundType>): ClosedRange<BoundType>

Returns a new range by joining other range and this.

fun <BoundType : Comparable<BoundType>, LengthType : Comparable<LengthType>> ClosedRange<BoundType>.splitByRange(other: ClosedRange<BoundType>, step: LengthType, math: BoundMath<BoundType, LengthType>, rangeFactory: RangeFactory<BoundType>): List<ClosedRange<BoundType>>

Cuts other range from this and returns a list of non-empty pieces that are left.

fun <BoundType : Comparable<BoundType>, LengthType : Comparable<LengthType>> ClosedRange<BoundType>.touchesRange(other: ClosedRange<BoundType>, step: LengthType, math: BoundMath<BoundType, LengthType>): Boolean

Checks if other range is located on a distance of step away from this.

fun <BoundType : Comparable<BoundType>> ClosedRange<BoundType>.trimmedByRange(other: ClosedRange<BoundType>, rangeFactory: RangeFactory<BoundType>): ClosedRange<BoundType>

Returns a new range by trimming this by other's bounds.