Std.Math

34 public declarations

• absT -> T where T: Ord + Zero + Sub

  The distance of a value from zero.

  fn
• betweenT -> T -> T -> Bool where T: Ord

  Whether a value lies between two bounds, inclusive at both ends.

  fn
• binaryGcdInt -> Int -> Int

  Stein's binary algorithm for the greatest common divisor.

  fn
• branchlessAbsInt -> Int

  Branchless absolute value of an integer.

  fn
• branchlessMaxInt -> Int -> Int

  Branchless maximum of two integers.

  fn
• branchlessMinInt -> Int -> Int

  Branchless minimum of two integers.

  fn
• checkedPowT -> Int -> Option[T] where T: One + Mul

  A value raised to a power, or `None` when the exponent is negative.

  fn
• clampT -> T -> T -> T where T: Ord

  Confine a value to a range, inclusive at both ends.

  fn
• cubeT -> T where T: Mul

  A value cubed.

  fn
• digitCountT -> Int where T: Ord + Zero + One + Add + Sub + Div

  The number of decimal digits, counting a lone nought as one and ignoring a

  fn
• divideT -> T -> Option[T] where T: Div

  Truncating division, or `None` when the divisor is nought.

  fn
• dividesT -> T -> Bool where T: Rem + Zero + Ord

  Whether a value divides another with no remainder. Nought divides nothing.

  fn
• divModT -> T -> Option[(T, T)] where T: Div + Rem

  The quotient and the remainder together, or `None` for a nought divisor.

  fn
• factorialT -> T where T: Ord + Zero + One + Add + Mul

  The product of every whole number from one up to the value.

  fn
• gcdT -> T -> T where T: Ord + Zero + One + Add + Sub + Rem

  The greatest common divisor, by Euclid's algorithm.

  fn
• ilog2Int -> Option[Int]

  Fast integer base-2 logarithm (floor(log2(n))) using bit shifts.

  fn
• isEvenT -> Bool where T: Rem + Zero + One + Add + Ord

  Whether a value is even.

  fn
• isOddT -> Bool where T: Rem + Zero + One + Add + Ord

  Whether a value is odd.

  fn
• isPowerOfTwoInt -> Bool

  Tests whether an integer is an exact positive power of two (1, 2, 4, 8, ...).

  fn
• isPrimeT -> Bool where T: Ord + Zero + One + Add + Mul + Rem

  Whether a value is prime. Values below two are not.

  fn
• isqrtT -> Option[T] where T: Ord + Zero + One + Add + Div

  The greatest value whose square does not exceed the given one.

  fn
• lcmT -> T -> T where T: Ord + Zero + One + Add + Sub + Mul + Div + Rem

  The least common multiple. Nought with either argument nought, since no

  fn
• maxT -> T -> T where T: Ord

  The larger of two values.

  fn
• maxByT -> T -> fn(T, T) -> Bool -> T

  The larger of two values, chosen by a comparison the caller supplies.

  fn
• minT -> T -> T where T: Ord

  The smaller of two values.

  fn
• minByT -> T -> fn(T, T) -> Bool -> T

  The smaller of two values, chosen by a comparison the caller supplies.

  fn
• nextPowerOfTwoInt -> Int

  Computes the smallest power of two greater than or equal to n.

  fn
• powT -> Int -> T where T: One + Mul

  A value raised to a non-negative power, by repeated squaring.

  fn
• predT -> T where T: One + Sub

  The previous value.

  fn
• remainderT -> T -> Option[T] where T: Rem

  The remainder of a truncating division, or `None` for a nought divisor.

  fn
• signumT -> T where T: Ord + Zero + One + Sub

  The sign of a value: -1, 0, or 1, in the value's own type.

  fn
• squareT -> T where T: Mul

  A value squared.

  fn
• subtractT -> T -> T where T: Sub

  One value taken from another, with the arguments in the order a reader meets

  fn
• succT -> T where T: One + Add

  The next value.

  fn