rtron-math/io.rtron.math.range

Package-level declarations

Types

Link copied to clipboard
enum BoundType : Enum<BoundType>

Bound types of intervals. See wikipedia article of intervals.

Link copied to clipboard
interface DefinableDomain<T : Comparable<*>>

Classes which have definable domain. See wikipedia article on domain of a function.

Link copied to clipboard
class Range<T : Comparable<*>>(range: Range<T>)

Represents a mathematical range. See wikipedia article of interval.

Link copied to clipboard
class RangeSet<T : Comparable<*>>(rangeSet: ImmutableRangeSet<T>)

An immutable set of ranges.

Link copied to clipboard
interface Tolerable

Classes which have a tolerance.

Functions

Link copied to clipboard
fun Range<Double>.arrange(step: Double, includeClosedEndPoint: Boolean = false, tolerance: Double): DoubleArray

Arranges an array of Double with step size.

Link copied to clipboard
fun <T : Comparable<*>> List<Range<T>>.containsConsecutivelyIntersectingRanges(): Boolean

Returns true, if the list of ranges contains consecutively following ranges that intersect.

Link copied to clipboard
fun <T : Comparable<*>> Set<Range<T>>.containsIntersectingRanges(): Boolean

Returns true, if the set of ranges contains intersecting Range.

Link copied to clipboard
fun <T : Comparable<*>> Set<RangeSet<T>>.containsIntersectingRangeSets(): Boolean

Returns true, if set of RangeSet contains intersecting RangeSet pairs.

Link copied to clipboard
fun Range<Double>.fuzzyContains(value: Double, tolerance: Double): Boolean

Returns true, if the value is fuzzily contained within this Range by the tolerance.

Link copied to clipboard
fun Range<Double>.fuzzyEncloses(other: Range<Double>, tolerance: Double): Boolean

Returns true, if the other is fuzzily enclosed with a tolerance.

Link copied to clipboard
fun <T : Comparable<*>> Set<Range<T>>.intersectingRange(): Range<T>

Returns the intersecting Range of a provided set of ranges.

Link copied to clipboard
fun <T : Comparable<*>> Set<RangeSet<T>>.intersectionRangeSets(): RangeSet<T>

Returns the intersecting RangeSet.

Link copied to clipboard
Link copied to clipboard
fun Range<Double>.shift(value: Double): Range<Double>

Shifts the Range by a value.

Link copied to clipboard
fun Range<Double>.shiftLowerEndpointTo(value: Double): Range<Double>

Shift the Range so that the lower endpoint is represented by the value.

Link copied to clipboard
fun BoundType.toBoundType(): BoundType

Conversion from Guava Bound Type class.

Link copied to clipboard
fun BoundType.toBoundTypeG(): BoundType?

Conversion to Guava Bound Type class.

Link copied to clipboard
fun <T : Comparable<*>> Range<T>.toRange(): Range<T>

Conversion from Guava range class.

Link copied to clipboard
fun <T : Comparable<*>> ImmutableRangeSet<T>.toRangeSet(): RangeSet<T>

Conversion from Guava range set class.

fun <T : Comparable<*>> Range<T>.toRangeSet(): RangeSet<T>

Conversion to RangeSet.

Link copied to clipboard
fun <T : Comparable<*>> Set<Range<T>>.unionRanges(): RangeSet<T>

Union operation of a set of Range to a RangeSet.

Link copied to clipboard
fun <T : Comparable<*>> Set<RangeSet<T>>.unionRangeSets(): RangeSet<T>

Unions a set of RangeSet to a single RangeSet.

Link copied to clipboard
fun Range<Double>.widened(wideningValue: Double): Range<Double>

Widens the Range by wideningValue on the lower and upper bound.

fun Range<Double>.widened(lowerWideningValue: Double, upperWideningValue: Double): Range<Double>

Widens the lower bound of the Range by lowerWideningValue and the upper bound of the Range by upperWideningValue.

Properties

Link copied to clipboard
val Range<Double>.difference: Double

Difference between the upper and lower bound of the Range.

Link copied to clipboard
val Range<Double>.length: Double

Absolute length between upper and lower bound.