Size extension type

An Interval size.

on
Implemented types
Implementers
Annotations
  • @immutable

Constructors

Size(int size)
Creates a new Size from size.
const

Properties

absShift int
The absolute Size value taking octave shift into account.
no setter
augmented Interval
The PerfectQuality.augmented or ImperfectQuality.augmented interval from this Size.
no setter
bitLength int
Returns the minimum number of bits required to store this integer.
no setterinherited
diminished Interval
The PerfectQuality.diminished or ImperfectQuality.diminished interval from this Size.
no setter
hashCode int
Returns a hash code for a numerical value.
no setterinherited
inverted Size
The inverted of this Size.
no setter
isCompound bool
Whether this Size is greater than Size.octave.
no setter
isDissonant bool
Whether this Size is dissonant.
no setter
isEven bool
Returns true if and only if this integer is even.
no setterinherited
isFinite bool
Whether this number is finite.
no setterinherited
isInfinite bool
Whether this number is positive infinity or negative infinity.
no setterinherited
isNaN bool
Whether this number is a Not-a-Number value.
no setterinherited
isNegative bool
Whether this number is negative.
no setterinherited
isOdd bool
Returns true if and only if this integer is odd.
no setterinherited
isPerfect bool
Whether this Size conforms a perfect interval.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
semitones int
The number of semitones of this Size as in _sizeToSemitones.
no setter
sign int
Returns the sign of this integer.
no setterinherited
simple Size
The simplified version of this Size.
no setter
size int
final

Methods

abs() int
Returns the absolute value of this integer.
inherited
ceil() int
Returns this.
inherited
ceilToDouble() double
Returns this.toDouble().
inherited
clamp(num lowerLimit, num upperLimit) num
Returns this num clamped to be in the range lowerLimit-upperLimit.
inherited
compareTo(num other) int
Compares this to other.
inherited
floor() int
Returns this.
inherited
floorToDouble() double
Returns this.toDouble().
inherited
format({IntervalNotation system = IntervalNotation.standard}) String
This Size formatted as a string.
gcd(int other) int
Returns the greatest common divisor of this integer and other.
inherited
modInverse(int modulus) int
Returns the modular multiplicative inverse of this integer modulo modulus.
inherited
modPow(int exponent, int modulus) int
Returns this integer to the power of exponent modulo modulus.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
remainder(num other) num
The remainder of the truncating division of this by other.
inherited
round() int
Returns this.
inherited
roundToDouble() double
Returns this.toDouble().
inherited
toDouble() double
This number as a double.
inherited
toInt() int
Truncates this num to an integer and returns the result as an int.
inherited
toRadixString(int radix) String
Converts this to a string representation in the given radix.
inherited
toSigned(int width) int
Returns the least significant width bits of this integer, extending the highest retained bit to the sign. This is the same as truncating the value to fit in width bits using an signed 2-s complement representation. The returned value has the same bit value in all positions higher than width.
inherited
toString() String
Returns a string representation of this integer.
inherited
toStringAsExponential([int? fractionDigits]) String
An exponential string-representation of this number.
inherited
toStringAsFixed(int fractionDigits) String
A decimal-point string-representation of this number.
inherited
toStringAsPrecision(int precision) String
A string representation with precision significant digits.
inherited
toUnsigned(int width) int
Returns the least significant width bits of this integer as a non-negative number (i.e. unsigned representation). The returned value has zeros in all bit positions higher than width.
inherited
truncate() int
Returns this.
inherited
truncateToDouble() double
Returns this.toDouble().
inherited

Operators

operator %(num other) num
Euclidean modulo of this number by other.
inherited
operator &(int other) int
Bit-wise and operator.
inherited
operator *(num other) num
Multiplies this number by other.
inherited
operator +(num other) num
Adds other to this number.
inherited
operator -(num other) num
Subtracts other from this number.
inherited
operator /(num other) double
Divides this number by other.
inherited
operator <(num other) bool
Whether this number is numerically smaller than other.
inherited
operator <<(int shiftAmount) int
Shift the bits of this integer to the left by shiftAmount.
inherited
operator <=(num other) bool
Whether this number is numerically smaller than or equal to other.
inherited
operator ==(Object other) bool
Test whether this value is numerically equal to other.
inherited
operator >(num other) bool
Whether this number is numerically greater than other.
inherited
operator >=(num other) bool
Whether this number is numerically greater than or equal to other.
inherited
operator >>(int shiftAmount) int
Shift the bits of this integer to the right by shiftAmount.
inherited
operator >>>(int shiftAmount) int
Bitwise unsigned right shift by shiftAmount bits.
inherited
operator ^(int other) int
Bit-wise exclusive-or operator.
inherited
operator unary-() Size
The negation of this Size.
override
operator |(int other) int
Bit-wise or operator.
inherited
operator ~() int
The bit-wise negate operator.
inherited
operator ~/(num other) int
Truncating division operator.
inherited

Static Methods

fromSemitones(int semitones) Size?
The Size that matches with semitones in _sizeToSemitones. Otherwise, returns null.

Constants

eleventh → const PerfectSize
An eleventh PerfectSize.
fifth → const PerfectSize
A fifth PerfectSize.
fourth → const PerfectSize
A fourth PerfectSize.
ninth → const ImperfectSize
A ninth ImperfectSize.
octave → const PerfectSize
An octave PerfectSize.
second → const ImperfectSize
A second ImperfectSize.
seventh → const ImperfectSize
A seventh ImperfectSize.
sixth → const ImperfectSize
A sixth ImperfectSize.
tenth → const ImperfectSize
A tenth ImperfectSize.
third → const ImperfectSize
A third ImperfectSize.
thirteenth → const ImperfectSize
A thirteenth ImperfectSize.
twelfth → const PerfectSize
A twelfth PerfectSize.
unison → const PerfectSize
A unison PerfectSize.