ranges library

Range classes and related extensions.

The most commonly used range is IntRange, which represents an arithmetic progression, e.g. 0..3, is the sequence 0, 1, 2, 3 with common difference (step) of 1.

You can work with progressions directly via range-related classes like IntRange or Progression, for example:

Range.upTo(3); // => 0..3
Range.progression(1, 3); // => 1..3
IntRange(1, 5, step: 2); // => 1, 3, 5
Progression(1, 5, step: 2); // => 1, 3, 5

The more intuitive way to create ranges might be using extension methods on int:

1.upTo(3); // => 1..3, alias for rangeTo
1.rangeTo(3); // same as above
1.upTo(5, step: 2); // => 1, 3, 5
1.until(3); // exclusive manner => 1, 2
3.downTo(1); // => 3..1
3.downUntil(1); // exclusive manner => 3,2

Furthermore, progressions are Iterable:

0.until(list.legth).forEach((i) => print(list[i]));
(list.legth - 1).downTo(0).forEach((i) => print(list[i]));

Another kind of range is closed floating-point range, which is much less useful. It is in fact a pair of numbers, marks the beginning and end of the range, respectively. So that it can represent a reverse range easily, e.g. 3.0..1.0.

Closed floating-point ranges can be created using the Range factory methods:

final range = Range.range(1.0, 3.0); // => 1.0..3.0
assert(range.contains(3.0));
assert(range.contains(1.0));
assert(range.contains(0.0) == false);

You can also use extension methods on double:

1.0.upTo(3.0); // => 1.0..3.0, alias for rangeTo
1.0.rangeTo(3.0); // same as above
final range = 3.0.downTo(1.0); // => 3.0..1.0
assert(3.0.withinRange(range));
assert(1.0.withinRange(range));
assert(0.0.withinRange(range) == false);

For more details, please see API docs.

Classes

EmptyIntRange
An empty IntRange, which contains no value. [...]
IntRange
A range of values of type int, and it also represents an arithmetic progression. [...]
Progression
An arithmetic progression. [...]
Range<T extends num>
Represents a range of numbers. [...]

Extensions

DoubleRangeExt
Add range extensions to double.
IntRangeExt
Add range extensions to int.
NumRangeExt
Add range extensions to num.