Packages > pkl > pkl.base

IntSeq0.27.0

Overview
Properties
Methods

external class IntSeq extends Any

A finite arithmetic sequence of integers.

Known subtypes:
Known usages:
All versions:

A sequence has a start, end, and step. It is either ascending (step > 0) or descending (step < 0). The default step is 1.

The members of a sequence are defined as:

seq(0) = start + 0 * step
seq(1) = start + 1 * step
seq(2) = start + 2 * step
etc. where seq(n) <= end if step > 0, and seq(n) >= end if step < 0

Construction

To construct a sequence, use method IntSeq():

ascending = IntSeq(2, 5)
empty = IntSeq(5, 2)

To set a step other than 1, use method step():

descending = IntSeq(5, 2).step(-2)

Iteration

To iterate over a sequence, use method map():

numbers = IntSeq(2, 5).map((n) -> n * 2)

A sequence can also be iterated over in a for-generator:

numbers {
  for (n in IntSeq(2, 5)) {
    n * 2
  }
}

Equality

Two sequences are equal if and only if they contain the same members in the same order.

Facts:

IntSeq(2, 5) == IntSeq(2, 5)
IntSeq(2, -3) == IntSeq(2, -2) // both empty
IntSeq(2, 5).step(2) == IntSeq(2, 4).step(2)

Properties

link
start: Int

The start of this sequence.
Facts:
```
IntSeq(2, 5).start == 2
```
link
end: Int

The inclusive end of this sequence.
Note that end may or may not be a member of this sequence.

Facts:
```
IntSeq(2, 5).start == 5
```
link
step: Int(isNonZero)

The common difference of successive members of this sequence.
Facts:
```
IntSeq(5, 2).step == 1
IntSeq(5, 2).step(-2).step == -2
```

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)

Returns the class of this.
link

function

Any.toString(): String (pkl.base)

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function
step(newValue: Int(isNonZero)): IntSeq

Changes step to newValue.
Facts:
```
IntSeq(5, 2).step == 1
IntSeq(5, 2).step(-2).step == -2
```
link

function

fold<Result>(initial: Result, operator: (Result, Int) -> Result): Result

Folds this sequence in iteration order using operator, starting with initial.
link

function
map<Result>(mapper: (Int) -> Result): List<Result>

Applies mapper to each member of this sequence and returns the resulting values as a list.
Facts:
```
IntSeq(2, 5).map((it) -> it) == List(2, 3, 4, 5)
IntSeq(5, 2).map((it) -> it) == List()
IntSeq(5, 2).step(-1).map((it) -> it * 2) == List(10, 8, 6, 4)
```
link

function

toList(): List<Int>

Converts the elements of this sequence to a List.
link

function

toListing(): Listing<Int>

Converts the elements of this sequence to a Listing.