Classes | Math

# Integer : SimpleNumber : Number : Magnitude : Object

Integer number
Source: Integer.sc

## Description

A 32 bit integer. Integer inherits most of its behaviour from its superclass.

NOTE: A 32 bit signed integer can represent values in the range -2147483648 to 2147483647. Adding up further returns in a wrapped result, so that and 2147483647+1= -2147483648. For a larger range, one can use Float, which is 64 bit and supports many (but not all) numerical methods that int does.

## Instance Methods

### .do(function)

Executes function for all integers from zero to this minus one.

#### Arguments:

 function a Function which is passed two arguments, both of which are the same integer from zero to this minus one. The reason two arguments are passed is for symmetry with the implementations of do in Collection.

### .reverseDo(function)

Executes function for all integers from this minus one to zero.

### .for(endval, function)

Executes function for all integers from this to endval, inclusive.

#### Arguments:

 endval an Integer. function a Function which is passed two arguments, the first which is an integer from this to endval, and the second which is a number from zero to the number of iterations minus one.

### .forBy(endval, stepval, function)

Executes function for all integers from this to endval, inclusive, stepping each time by stepval.

#### Arguments:

 endval an Integer. stepval an Integer. function a Function which is passed two arguments, the first which is an integer from this to endval, and the second which is a number from zero to the number of iterations minus one.

### .collect(function)

#### Returns:

an Array of this size filled by objects generated from evaluating the function.

### .collectAs(function, class)

#### Returns:

a Collection of class of this size filled by objects generated from evaluating the function.

### .to(hi, step: 1)

#### Returns:

an Interval from this to hi.

### .geom(start, grow)

#### Returns:

an array with a geometric series of this size from start.

### .fib(a: 0.0, b: 1.0)

#### Returns:

an array with a fibonacci series of this size beginning with a and b.

### .factors

#### Returns:

the prime factors as array.

### .xrand(exclude: 0)

#### Arguments:

 exclude an Integer.

#### Returns:

a random value from zero to this, excluding the value exclude.

### .xrand2(exclude: 0)

#### Arguments:

 exclude an Integer.

#### Returns:

a random value from this.neg to this, excluding the value exclude.

### .asAscii

#### Returns:

a Char which has the ASCII value of the receiver.

### .asDigit

#### Returns:

a Char which represents the receiver as an ASCII digit.

#### Discussion:

For example `5.asDigit` returns `\$5`.

### .asBinaryDigits(numDigits: 8)

#### Returns:

an array with the binary digits (integer 0 or 1).

### .asDigits(base: 10, numDigits)

#### Returns:

an array with the n-ary digits.

### .asBinaryString(width: 8)

#### Returns:

a string with the binary digits (0 or 1).

### .asHexString(width: 8)

#### Returns:

a string with the hexadecimal digits (integer 0 to F).

### .asIPString

#### Returns:

a string in IP format.

### .asStringToBase(base: 10, width: 8)

#### Returns:

a string with `width`-rightmost digits in base `base`.

### .degreeToKey(scale, stepsPerOctave: 12)

Interpret this as index into a scale with a given number of steps per ocatve.

### .grayCode

#### Returns:

the gray code for the number.

a hash value.

### .setBit(bitNumber, bool: true)

set nth bit to zero (bool = false) or one (bool = true)

`{ _CLZ }`

### .trailingZeroes

`{ _CTZ }`

### .numBits

#### Returns:

number of required bits

### .even

#### Returns:

true if dividable by 2 with no rest

### .odd

#### Returns:

true if not dividable by 2 with no rest

### .nextPowerOfTwo

#### Returns:

the next power of two greater than or equal to the receiver.

### .isPowerOfTwo

#### Returns:

the whether the receiver is a power of two.

### .nthPrime

#### Returns:

the nth prime number. The receiver must be from 0 to 6541.

### .prevPrime

#### Returns:

the next prime less than or equal to the receiver up to 65521.

### .nextPrime

#### Returns:

the next prime less than or equal to the receiver up to 65521.

### .indexOfPrime

#### Returns:

the index of a prime number less than or equal to the receiver up to 65521. If the receiver is not a prime, the answer is nil.

Multiplication.

Subtraction.

### .clip(lo, hi)

#### Returns:

• the receiver if it is between `lo` and `hi`
• `lo` if the receiver is less than `lo`
• `hi` if the receiver is greater than `hi`

The result is an Integer only if both `lo` and `hi` are Integers.

### .factorial

#### Returns:

the factorial of the receiver as an integer. This will overflow for numbers `> 12` and throw an error. Floating point factorials can be used in such cases (see: SimpleNumber: -factorial).

### .fold(lo, hi)

Folds in to a value between `lo` and `hi`.

#### Returns:

an Integer between `lo` and `hi`.

### .log2Ceil

#### Returns:

next larger integer of the base 2 logarithm of the receiver.

### .wrap(lo, hi)

Wraps in to a value between `lo` and `hi`.

#### Returns:

an Integer between `lo` and `hi`.

### .clip(lo, hi)

Return this if lo <= this <= hi, otherwise return the nearest boundary: lo if this < lo, hi if this > hi.

#### Arguments:

 lo The low threshold of clipping. hi The high threshold of clipping.

### .fold(lo, hi)

Fold this to [lo, hi].

#### Arguments:

 lo The low threshold of folding. hi The high threshold of folding.

### .wrap(lo, hi)

Wrap this around [lo, hi] such that it falls in range. Equivalent to (this % (hi - lo + 1)) + lo. Note that this behavior is different from Float: -wrap.

#### Arguments:

 lo The low threshold (inclusive) of wrapping. hi The high threshold (inclusive) of wrapping.

### .exit

#### Returns:

exits the sclang program and returns the receiver as an exit code to the parent process (e.g. Unix shell).

### .generate(function)

#### Returns:

calls `function.value(receiver)` but returns the receiver.

### .isInteger

#### Returns:

true (the receiver is an integer).

### .isShift

#### Returns:

a Boolean for whether or not the given key modifier is in effect. For a list of these, see Modifier Keys.

### .pidRunning

#### Returns:

a Boolean for whether or not the specified pid is running.

### .ascii

From extension in /home/stefan/.local/share/SuperCollider/Extensions/Strang/Strang.sc

### .wrand(probabilities)

From extension in /home/stefan/.local/share/SuperCollider/Extensions/wrand.sc