# BigIntIsIntegral

### Related Docs: object BigIntIsIntegral | package Numeric

#### trait BigIntIsIntegral extends Integral[BigInt]

Source
Numeric.scala
Linear Supertypes
Known Subclasses
Ordering
1. Alphabetic
2. By inheritance
Inherited
1. BigIntIsIntegral
2. Integral
3. Numeric
4. Ordering
5. PartialOrdering
6. Equiv
7. Serializable
8. Serializable
9. Comparator
10. AnyRef
11. Any
Implicitly
1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc
1. Hide All
2. Show all
Visibility
1. Public
2. All

### Type Members

1. #### class IntegralOps extends Ops

Definition Classes
Integral
2. #### class Ops extends AnyRef

Definition Classes
Numeric

### Abstract Value Members

1. #### abstract def compare(x: BigInt, y: BigInt): Int

Returns an integer whose sign communicates how x compares to y.

Returns an integer whose sign communicates how x compares to y.

The result sign has the following meaning:

• negative if x < y
• positive if x > y
• zero otherwise (if x == y)
Definition Classes
Ordering → Comparator

### Concrete Value Members

1. #### final def !=(arg0: Any): Boolean

Test two objects for inequality.

Test two objects for inequality.

returns

`true` if !(this == that), false otherwise.

Definition Classes
AnyRef → Any
2. #### final def ##(): Int

Equivalent to `x.hashCode` except for boxed numeric types and `null`.

Equivalent to `x.hashCode` except for boxed numeric types and `null`. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For `null` returns a hashcode where `null.hashCode` throws a `NullPointerException`.

returns

a hash value consistent with ==

Definition Classes
AnyRef → Any
3. #### def +(other: String): String

Implicit information
This member is added by an implicit conversion from BigIntIsIntegral to any2stringadd[BigIntIsIntegral] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
4. #### def ->[B](y: B): (BigIntIsIntegral, B)

Implicit information
This member is added by an implicit conversion from BigIntIsIntegral to ArrowAssoc[BigIntIsIntegral] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
()
5. #### final def ==(arg0: Any): Boolean

The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

arg0

the object to compare against this object for equality.

returns

`true` if the receiver object is equivalent to the argument; `false` otherwise.

Definition Classes
AnyRef → Any
6. #### def abs(x: BigInt): BigInt

Definition Classes
Numeric
7. #### final def asInstanceOf[T0]: T0

Cast the receiver object to be of type `T0`.

Cast the receiver object to be of type `T0`.

Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression `1.asInstanceOf[String]` will throw a `ClassCastException` at runtime, while the expression `List(1).asInstanceOf[List[String]]` will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

returns

the receiver object.

Definition Classes
Any
Exceptions thrown

`ClassCastException` if the receiver object is not an instance of the erasure of type `T0`.

8. #### def clone(): AnyRef

Create a copy of the receiver object.

Create a copy of the receiver object.

The default implementation of the `clone` method is platform dependent.

returns

a copy of the receiver object.

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
( ... )
Note

not specified by SLS as a member of AnyRef

9. #### def ensuring(cond: (BigIntIsIntegral) ⇒ Boolean, msg: ⇒ Any): BigIntIsIntegral

Implicit information
This member is added by an implicit conversion from BigIntIsIntegral to Ensuring[BigIntIsIntegral] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
10. #### def ensuring(cond: (BigIntIsIntegral) ⇒ Boolean): BigIntIsIntegral

Implicit information
This member is added by an implicit conversion from BigIntIsIntegral to Ensuring[BigIntIsIntegral] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
11. #### def ensuring(cond: Boolean, msg: ⇒ Any): BigIntIsIntegral

Implicit information
This member is added by an implicit conversion from BigIntIsIntegral to Ensuring[BigIntIsIntegral] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
12. #### def ensuring(cond: Boolean): BigIntIsIntegral

Implicit information
This member is added by an implicit conversion from BigIntIsIntegral to Ensuring[BigIntIsIntegral] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
13. #### final def eq(arg0: AnyRef): Boolean

Tests whether the argument (`arg0`) is a reference to the receiver object (`this`).

Tests whether the argument (`arg0`) is a reference to the receiver object (`this`).

The `eq` method implements an equivalence relation on non-null instances of `AnyRef`, and has three additional properties:

• It is consistent: for any non-null instances `x` and `y` of type `AnyRef`, multiple invocations of `x.eq(y)` consistently returns `true` or consistently returns `false`.
• For any non-null instance `x` of type `AnyRef`, `x.eq(null)` and `null.eq(x)` returns `false`.
• `null.eq(null)` returns `true`.

When overriding the `equals` or `hashCode` methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (`o1 eq o2`), they should be equal to each other (`o1 == o2`) and they should hash to the same value (`o1.hashCode == o2.hashCode`).

returns

`true` if the argument is a reference to the receiver object; `false` otherwise.

Definition Classes
AnyRef
14. #### def equals(arg0: Any): Boolean

The equality method for reference types.

The equality method for reference types. Default implementation delegates to `eq`.

See also `equals` in scala.Any.

returns

`true` if the receiver object is equivalent to the argument; `false` otherwise.

Definition Classes
AnyRef → Any
15. #### def equiv(x: BigInt, y: BigInt): Boolean

Return true if `x` == `y` in the ordering.

Return true if `x` == `y` in the ordering.

Definition Classes
OrderingPartialOrderingEquiv
16. #### def finalize(): Unit

Called by the garbage collector on the receiver object when there are no more references to the object.

Called by the garbage collector on the receiver object when there are no more references to the object.

The details of when and if the `finalize` method is invoked, as well as the interaction between `finalize` and non-local returns and exceptions, are all platform dependent.

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
( classOf[java.lang.Throwable] )
Note

not specified by SLS as a member of AnyRef

17. #### def formatted(fmtstr: String): String

Returns string formatted according to given `format` string.

Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

Implicit information
This member is added by an implicit conversion from BigIntIsIntegral to StringFormat[BigIntIsIntegral] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
()
18. #### def fromInt(x: Int): BigInt

Definition Classes
BigIntIsIntegralNumeric
19. #### final def getClass(): Class[_]

A representation that corresponds to the dynamic class of the receiver object.

A representation that corresponds to the dynamic class of the receiver object.

The nature of the representation is platform dependent.

returns

a representation that corresponds to the dynamic class of the receiver object.

Definition Classes
AnyRef → Any
Note

not specified by SLS as a member of AnyRef

20. #### def gt(x: BigInt, y: BigInt): Boolean

Return true if `x` > `y` in the ordering.

Return true if `x` > `y` in the ordering.

Definition Classes
OrderingPartialOrdering
21. #### def gteq(x: BigInt, y: BigInt): Boolean

Return true if `x` >= `y` in the ordering.

Return true if `x` >= `y` in the ordering.

Definition Classes
OrderingPartialOrdering
22. #### def hashCode(): Int

The hashCode method for reference types.

The hashCode method for reference types. See hashCode in scala.Any.

returns

the hash code value for this object.

Definition Classes
AnyRef → Any
23. #### final def isInstanceOf[T0]: Boolean

Test whether the dynamic type of the receiver object is `T0`.

Test whether the dynamic type of the receiver object is `T0`.

Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression `1.isInstanceOf[String]` will return `false`, while the expression `List(1).isInstanceOf[List[String]]` will return `true`. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

returns

`true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

Definition Classes
Any
24. #### def lt(x: BigInt, y: BigInt): Boolean

Return true if `x` < `y` in the ordering.

Return true if `x` < `y` in the ordering.

Definition Classes
OrderingPartialOrdering
25. #### def lteq(x: BigInt, y: BigInt): Boolean

Return true if `x` <= `y` in the ordering.

Return true if `x` <= `y` in the ordering.

Definition Classes
OrderingPartialOrdering
26. #### def max(x: BigInt, y: BigInt): BigInt

Return `x` if `x` >= `y`, otherwise `y`.

Return `x` if `x` >= `y`, otherwise `y`.

Definition Classes
Ordering
27. #### def min(x: BigInt, y: BigInt): BigInt

Return `x` if `x` <= `y`, otherwise `y`.

Return `x` if `x` <= `y`, otherwise `y`.

Definition Classes
Ordering
28. #### def minus(x: BigInt, y: BigInt): BigInt

Definition Classes
BigIntIsIntegralNumeric
29. #### implicit def mkNumericOps(lhs: BigInt): IntegralOps

Definition Classes
IntegralNumeric
30. #### implicit def mkOrderingOps(lhs: BigInt): BigIntIsIntegral.Ops

This implicit method augments `T` with the comparison operators defined in `scala.math.Ordering.Ops`.

This implicit method augments `T` with the comparison operators defined in `scala.math.Ordering.Ops`.

Definition Classes
Ordering
31. #### final def ne(arg0: AnyRef): Boolean

Equivalent to `!(this eq that)`.

Equivalent to `!(this eq that)`.

returns

`true` if the argument is not a reference to the receiver object; `false` otherwise.

Definition Classes
AnyRef
32. #### def negate(x: BigInt): BigInt

Definition Classes
BigIntIsIntegralNumeric
33. #### final def notify(): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.

Wakes up a single thread that is waiting on the receiver object's monitor.

Definition Classes
AnyRef
Note

not specified by SLS as a member of AnyRef

34. #### final def notifyAll(): Unit

Wakes up all threads that are waiting on the receiver object's monitor.

Wakes up all threads that are waiting on the receiver object's monitor.

Definition Classes
AnyRef
Note

not specified by SLS as a member of AnyRef

35. #### def on[U](f: (U) ⇒ BigInt): Ordering[U]

Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:

Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:

`def compare(x:U, y:U) = Ordering[T].compare(f(x), f(y))`
Definition Classes
Ordering
36. #### def one: BigInt

Definition Classes
Numeric
37. #### def plus(x: BigInt, y: BigInt): BigInt

Definition Classes
BigIntIsIntegralNumeric
38. #### def quot(x: BigInt, y: BigInt): BigInt

Definition Classes
BigIntIsIntegralIntegral
39. #### def rem(x: BigInt, y: BigInt): BigInt

Definition Classes
BigIntIsIntegralIntegral
40. #### def reverse: Ordering[BigInt]

Return the opposite ordering of this one.

Return the opposite ordering of this one.

Definition Classes
OrderingPartialOrdering
41. #### def signum(x: BigInt): Int

Definition Classes
Numeric
42. #### final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
43. #### def times(x: BigInt, y: BigInt): BigInt

Definition Classes
BigIntIsIntegralNumeric
44. #### def toDouble(x: BigInt): Double

Definition Classes
BigIntIsIntegralNumeric
45. #### def toFloat(x: BigInt): Float

Definition Classes
BigIntIsIntegralNumeric
46. #### def toInt(x: BigInt): Int

Definition Classes
BigIntIsIntegralNumeric
47. #### def toLong(x: BigInt): Long

Definition Classes
BigIntIsIntegralNumeric
48. #### def toString(): String

Creates a String representation of this object.

Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

returns

a String representation of the object.

Definition Classes
AnyRef → Any
49. #### def tryCompare(x: BigInt, y: BigInt): Some[Int]

Returns whether a comparison between `x` and `y` is defined, and if so the result of `compare(x, y)`.

Returns whether a comparison between `x` and `y` is defined, and if so the result of `compare(x, y)`.

Definition Classes
OrderingPartialOrdering
50. #### final def wait(): Unit

Definition Classes
AnyRef
Annotations
( ... )
51. #### final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
( ... )
52. #### final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
( ... )
53. #### def zero: BigInt

Definition Classes
Numeric
54. #### def →[B](y: B): (BigIntIsIntegral, B)

Implicit information
This member is added by an implicit conversion from BigIntIsIntegral to ArrowAssoc[BigIntIsIntegral] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc