int class - dart:core library (original) (raw)

An integer number.

The default implementation of int is 64-bit two's complement integers with operations that wrap to that range on overflow.

Note: When compiling to JavaScript, integers are restricted to values that can be represented exactly by double-precision floating point values. The available integer values include all integers between -2^53 and 2^53, and some integers with larger magnitude. That includes some integers larger than 2^63. The behavior of the operators and methods in the intclass therefore sometimes differs between the Dart VM and Dart code compiled to JavaScript. For example, the bitwise operators truncate their operands to 32-bit integers when compiled to JavaScript.

Classes cannot extend, implement, or mix in int.

See also:

Inheritance

Available extensions

Constructors

int.fromEnvironment(String name, {int defaultValue = 0})

Integer value for name in the compilation configuration environment.

const

factory

Properties

addressPointer<Never>

Available on int, provided by the IntAddress extension

The memory address of the underlying data.

getter/setter pair

bitLengthint

Returns the minimum number of bits required to store this integer.

no setter

hashCodeint

Returns a hash code for a numerical value.

no setterinherited

isEvenbool

Returns true if and only if this integer is even.

no setter

isFinitebool

Whether this number is finite.

no setterinherited

isInfinitebool

Whether this number is positive infinity or negative infinity.

no setterinherited

isNaNbool

Whether this number is a Not-a-Number value.

no setterinherited

isNegativebool

Whether this number is negative.

no setterinherited

isOddbool

Returns true if and only if this integer is odd.

no setter

runtimeTypeType

A representation of the runtime type of the object.

no setterinherited

signint

Returns the sign of this integer.

no setteroverride

toJSJSNumber

Available on num, provided by the NumToJSExtension extension

Converts this num to a JSNumber.

no setter

Methods

abs()→ int

Returns the absolute value of this integer.

override

ceil()→ int

Returns this.

override

ceilToDouble()→ double

Returns this.toDouble().

override

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.

override

floorToDouble()→ double

Returns this.toDouble().

override

gcd(int other)→ int

Returns the greatest common divisor of this integer and other.

modInverse(int modulus)→ int

Returns the modular multiplicative inverse of this integer modulo modulus.

modPow(int exponent, int modulus)→ int

Returns this integer to the power of exponent modulo modulus.

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.

override

roundToDouble()→ double

Returns this.toDouble().

override

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 int to a string representation in the given radix.

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.

toString()→ String

Returns a string representation of this integer.

override

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.

truncate()→ int

Returns this.

override

truncateToDouble()→ double

Returns this.toDouble().

override

Operators

operator %(num other)→ num

Euclidean modulo of this number by other.

inherited

operator &(int other)→ int

Bit-wise and operator.

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.

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.

operator >>>(int shiftAmount)→ int

Bitwise unsigned right shift by shiftAmount bits.

operator ^(int other)→ int

Bit-wise exclusive-or operator.

operator unary-()→ int

Return the negative value of this integer.

override

operator |(int other)→ int

Bit-wise or operator.

operator ~()→ int

The bit-wise negate operator.

operator ~/(num other)→ int

Truncating division operator.

inherited

Static Methods

parse(String source, {int? radix})→ int

Parse source as a, possibly signed, integer literal and return its value.

override

tryParse(String source, {int? radix})→ int?

Parse source as a, possibly signed, integer literal.

override