final class PosLong extends AnyVal

An AnyVal for positive Longs.

Note: a PosLong may not equal 0. If you want positive number or 0, use PosZLong.

Because PosLong is an AnyVal it will usually be as efficient as an Long, being boxed only when an Long would have been boxed.

The PosLong.apply factory method is implemented in terms of a macro that checks literals for validity at compile time. Calling PosLong.apply with a literal Long value will either produce a valid PosLong instance at run time or an error at compile time. Here's an example:

scala> import anyvals._
import anyvals._
scala> PosLong(1L)
res0: org.scalactic.anyvals.PosLong = PosLong(1)
scala> PosLong(0L)
<console>:14: error: PosLong.apply can only be invoked on a positive (i > 0L) integer literal, like PosLong(42L).
 PosLong(0L)
 ^

PosLong.apply cannot be used if the value being passed is a variable (i.e., not a literal), because the macro cannot determine the validity of variables at compile time (just literals). If you try to pass a variable to PosLong.apply, you'll get a compiler error that suggests you use a different factor method, PosLong.from, instead:

scala> val x = 1L
x: Long = 1
scala> PosLong(x)
<console>:15: error: PosLong.apply can only be invoked on an integer literal, like PosLong(42L). Please use PosLong.from instead.
 PosLong(x)
 ^

The PosLong.from factory method will inspect the value at runtime and return an Option[PosLong]. If the value is valid, PosLong.from will return a Some[PosLong], else it will return a None. Here's an example:

scala> PosLong.from(x)
res3: Option[org.scalactic.anyvals.PosLong] = Some(PosLong(1))
scala> val y = 0L
y: Long = 0
scala> PosLong.from(y)
res4: Option[org.scalactic.anyvals.PosLong] = None

The PosLong.apply factory method is marked implicit, so that you can pass literal Longs into methods that require PosLong, and get the same compile-time checking you get when calling PosLong.apply explicitly. Here's an example:

scala> def invert(pos: PosLong): Long = Long.MaxValue - pos
invert: (pos: org.scalactic.anyvals.PosLong)Long
scala> invert(1L)
res5: Long = 9223372036854775806
scala> invert(Long.MaxValue)
res6: Long = 0
scala> invert(0L)
<console>:15: error: PosLong.apply can only be invoked on a positive (i > 0L) integer literal, like PosLong(42L).
 invert(0L)
 ^
scala> invert(-1L)
<console>:15: error: PosLong.apply can only be invoked on a positive (i > 0L) integer literal, like PosLong(42L).
 invert(-1L)
 ^

This example also demonstrates that the PosLong companion object also defines implicit widening conversions when either no loss of precision will occur or a similar conversion is provided in Scala. (For example, the implicit conversion from Long to Double in Scala can lose precision.) This makes it convenient to use a PosLong where a Long or wider type is needed. An example is the subtraction in the body of the invert method defined above, Long.MaxValue - pos. Although Long.MaxValue is a Long, which has no - method that takes a PosLong (the type of pos), you can still subtract pos, because the PosLong will be implicitly widened to Long.

Source: PosLong.scala

Linear Supertypes

AnyVal, Any

Ordering

Alphabetic
By Inheritance

Inherited

PosLong
AnyVal
Any

Hide All
Show All

Visibility

Public
All

Value Members

final def !=(arg0: Any): Boolean
Permalink

Definition Classes
Any
final def ##(): Int
Permalink

Definition Classes
Any
def %(x: Double): Double
Permalink
Returns the remainder of the division of this value by x.
def %(x: Float): Float
Permalink
Returns the remainder of the division of this value by x.
def %(x: Long): Long
Permalink
Returns the remainder of the division of this value by x.
def %(x: Int): Long
Permalink
Returns the remainder of the division of this value by x.
def %(x: Char): Long
Permalink
Returns the remainder of the division of this value by x.
def %(x: Short): Long
Permalink
Returns the remainder of the division of this value by x.
def %(x: Byte): Long
Permalink
Returns the remainder of the division of this value by x.
def &(x: Long): Long
Permalink
Returns the bitwise AND of this value and x.
Returns the bitwise AND of this value and x.
Example:
1. (0xf0 & 0xaa) == 0xa0 // in binary: 11110000 // & 10101010 // -------- // 10100000
def &(x: Int): Long
Permalink
Returns the bitwise AND of this value and x.
Returns the bitwise AND of this value and x.
Example:
1. (0xf0 & 0xaa) == 0xa0 // in binary: 11110000 // & 10101010 // -------- // 10100000
def &(x: Char): Long
Permalink
Returns the bitwise AND of this value and x.
Returns the bitwise AND of this value and x.
Example:
1. (0xf0 & 0xaa) == 0xa0 // in binary: 11110000 // & 10101010 // -------- // 10100000
def &(x: Short): Long
Permalink
Returns the bitwise AND of this value and x.
Returns the bitwise AND of this value and x.
Example:
1. (0xf0 & 0xaa) == 0xa0 // in binary: 11110000 // & 10101010 // -------- // 10100000
def &(x: Byte): Long
Permalink
Returns the bitwise AND of this value and x.
Returns the bitwise AND of this value and x.
Example:
1. (0xf0 & 0xaa) == 0xa0 // in binary: 11110000 // & 10101010 // -------- // 10100000
def *(x: Double): Double
Permalink
Returns the product of this value and x.
def *(x: Float): Float
Permalink
Returns the product of this value and x.
def *(x: Long): Long
Permalink
Returns the product of this value and x.
def *(x: Int): Long
Permalink
Returns the product of this value and x.
def *(x: Char): Long
Permalink
Returns the product of this value and x.
def *(x: Short): Long
Permalink
Returns the product of this value and x.
def *(x: Byte): Long
Permalink
Returns the product of this value and x.
def +(x: Double): Double
Permalink
Returns the sum of this value and x.
def +(x: Float): Float
Permalink
Returns the sum of this value and x.
def +(x: Long): Long
Permalink
Returns the sum of this value and x.
def +(x: Int): Long
Permalink
Returns the sum of this value and x.
def +(x: Char): Long
Permalink
Returns the sum of this value and x.
def +(x: Short): Long
Permalink
Returns the sum of this value and x.
def +(x: Byte): Long
Permalink
Returns the sum of this value and x.
def +(x: String): String
Permalink
Converts this PosLong's value to a string then concatenates the given string.
Converts this PosLong's value to a string then concatenates the given string.
def -(x: Double): Double
Permalink
Returns the difference of this value and x.
def -(x: Float): Float
Permalink
Returns the difference of this value and x.
def -(x: Long): Long
Permalink
Returns the difference of this value and x.
def -(x: Int): Long
Permalink
Returns the difference of this value and x.
def -(x: Char): Long
Permalink
Returns the difference of this value and x.
def -(x: Short): Long
Permalink
Returns the difference of this value and x.
def -(x: Byte): Long
Permalink
Returns the difference of this value and x.
def /(x: Double): Double
Permalink
Returns the quotient of this value and x.
def /(x: Float): Float
Permalink
Returns the quotient of this value and x.
def /(x: Long): Long
Permalink
Returns the quotient of this value and x.
def /(x: Int): Long
Permalink
Returns the quotient of this value and x.
def /(x: Char): Long
Permalink
Returns the quotient of this value and x.
def /(x: Short): Long
Permalink
Returns the quotient of this value and x.
def /(x: Byte): Long
Permalink
Returns the quotient of this value and x.
def <(x: Double): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Float): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Long): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Int): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Char): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Short): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Byte): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <<(x: Long): Long
Permalink
Returns this value bit-shifted left by the specified number of bits, filling in the new right bits with zeroes.
Returns this value bit-shifted left by the specified number of bits, filling in the new right bits with zeroes.
Example:
1. 6 << 3 == 48 // in binary: 0110 << 3 == 0110000
def <<(x: Int): Long
Permalink
Returns this value bit-shifted left by the specified number of bits, filling in the new right bits with zeroes.
Returns this value bit-shifted left by the specified number of bits, filling in the new right bits with zeroes.
Example:
1. 6 << 3 == 48 // in binary: 0110 << 3 == 0110000
def <=(x: Double): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Float): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Long): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Int): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Char): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Short): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Byte): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
final def ==(arg0: Any): Boolean
Permalink

Definition Classes
Any
def >(x: Double): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Float): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Long): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Int): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Char): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Short): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Byte): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >=(x: Double): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Float): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Long): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Int): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Char): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Short): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Byte): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >>(x: Long): Long
Permalink
Returns this value bit-shifted left by the specified number of bits, filling in the right bits with the same value as the left-most bit of this.
Returns this value bit-shifted left by the specified number of bits, filling in the right bits with the same value as the left-most bit of this. The effect of this is to retain the sign of the value.
Example:
1. -21 >> 3 == -3 // in binary: 11111111 11111111 11111111 11101011>> 3 == // 11111111 11111111 11111111 11111101
def >>(x: Int): Long
Permalink
Returns this value bit-shifted left by the specified number of bits, filling in the right bits with the same value as the left-most bit of this.
Returns this value bit-shifted left by the specified number of bits, filling in the right bits with the same value as the left-most bit of this. The effect of this is to retain the sign of the value.
Example:
1. -21 >> 3 == -3 // in binary: 11111111 11111111 11111111 11101011>> 3 == // 11111111 11111111 11111111 11111101
def >>>(x: Long): Long
Permalink
Returns this value bit-shifted right by the specified number of bits, filling the new left bits with zeroes.
Returns this value bit-shifted right by the specified number of bits, filling the new left bits with zeroes.
Examples:
1. -21 >>> 3 == 536870909 // in binary: 11111111 11111111 11111111 11101011>>> 3 == // 00011111 11111111 11111111 11111101
2. 21 >>> 3 == 2 // in binary: 010101>>> 3 == 010
def >>>(x: Int): Long
Permalink
Returns this value bit-shifted right by the specified number of bits, filling the new left bits with zeroes.
Returns this value bit-shifted right by the specified number of bits, filling the new left bits with zeroes.
Examples:
1. -21 >>> 3 == 536870909 // in binary: 11111111 11111111 11111111 11101011>>> 3 == // 00011111 11111111 11111111 11111101
2. 21 >>> 3 == 2 // in binary: 010101>>> 3 == 010
def ^(x: Long): Long
Permalink
Returns the bitwise XOR of this value and x.
Returns the bitwise XOR of this value and x.
Example:
1. (0xf0 ^ 0xaa) == 0x5a // in binary: 11110000 // ^ 10101010 // -------- // 01011010
def ^(x: Int): Long
Permalink
Returns the bitwise XOR of this value and x.
Returns the bitwise XOR of this value and x.
Example:
1. (0xf0 ^ 0xaa) == 0x5a // in binary: 11110000 // ^ 10101010 // -------- // 01011010
def ^(x: Char): Long
Permalink
Returns the bitwise XOR of this value and x.
Returns the bitwise XOR of this value and x.
Example:
1. (0xf0 ^ 0xaa) == 0x5a // in binary: 11110000 // ^ 10101010 // -------- // 01011010
def ^(x: Short): Long
Permalink
Returns the bitwise XOR of this value and x.
Returns the bitwise XOR of this value and x.
Example:
1. (0xf0 ^ 0xaa) == 0x5a // in binary: 11110000 // ^ 10101010 // -------- // 01011010
def ^(x: Byte): Long
Permalink
Returns the bitwise XOR of this value and x.
Returns the bitwise XOR of this value and x.
Example:
1. (0xf0 ^ 0xaa) == 0x5a // in binary: 11110000 // ^ 10101010 // -------- // 01011010
final def asInstanceOf[T0]: T0
Permalink

Definition Classes
Any
def getClass(): Class[_ <: AnyVal]
Permalink

Definition Classes
AnyVal → Any
final def isInstanceOf[T0]: Boolean
Permalink

Definition Classes
Any
def max(that: PosLong ): PosLong
Permalink
Returns this if this > that or that otherwise.
Returns this if this > that or that otherwise.
def min(that: PosLong ): PosLong
Permalink
Returns this if this < that or that otherwise.
Returns this if this < that or that otherwise.
def to(end: Long, step: Long): Inclusive[Long]
Permalink
Create an inclusive Range from this PosLong value to the specified end with the specified step value.
Create an inclusive Range from this PosLong value to the specified end with the specified step value.
end
The final bound of the range to make.
step
The number to increase by for each step of the range.
returns
A scala.collection.immutable.NumericRange.Inclusive[Long] from this up to and including end.
def to(end: Long): Inclusive[Long]
Permalink
Create an inclusive Range from this PosLong value to the specified end with step value 1.
Create an inclusive Range from this PosLong value to the specified end with step value 1.
end
The final bound of the range to make.
returns
A scala.collection.immutable.NumericRange.Inclusive[Long] from this up to and including end.
def toBinaryString: String
Permalink
Returns a string representation of this PosLong's underlying Long as an unsigned integer in base 2.
Returns a string representation of this PosLong's underlying Long as an unsigned integer in base 2.
The unsigned long value is this PosLong's underlying Long plus 2⁶⁴ if the underlying Long is negative; otherwise, it is equal to the underlying Long. This value is converted to a string of ASCII digits in binary (base 2) with no extra leading 0s. If the unsigned magnitude is zero, it is represented by a single zero character '0' ('\u0030'); otherwise, the first character of the representation of the unsigned magnitude will not be the zero character. The characters '0' ('\u0030') and '1' ('\u0031') are used as binary digits.
returns
the string representation of the unsigned long value represented by this PosLong's underlying Long in binary (base 2).
def toByte: Byte
Permalink
Converts this PosLong to a Byte.
Converts this PosLong to a Byte.
def toChar: Char
Permalink
Converts this PosLong to a Char.
Converts this PosLong to a Char.
def toDouble: Double
Permalink
Converts this PosLong to a Double.
Converts this PosLong to a Double.
def toFloat: Float
Permalink
Converts this PosLong to a Float.
Converts this PosLong to a Float.
def toHexString: String
Permalink
Returns a string representation of this PosLong's underlying Long as an unsigned integer in base 16.
Returns a string representation of this PosLong's underlying Long as an unsigned integer in base 16.
The unsigned long value is this PosLong's underlying Long plus 2⁶⁴ if the underlying Long is negative; otherwise, it is equal to the underlying Long. This value is converted to a string of ASCII digits in hexadecimal (base 16) with no extra leading 0s. If the unsigned magnitude is zero, it is represented by a single zero character '0' ('\u0030'); otherwise, the first character of the representation of the unsigned magnitude will not be the zero character. The following characters are used as hexadecimal digits:
0123456789abcdef
These are the characters '\u0030' through '\u0039' and '\u0061' through '\u0066'. If uppercase letters are desired, the toUpperCase method may be called on the result.
returns
the string representation of the unsigned long value represented by this PosLong's underlying Long in hexadecimal (base 16).
def toInt: Int
Permalink
Converts this PosLong to an Int.
Converts this PosLong to an Int.
def toLong: Long
Permalink
Converts this PosLong to a Long.
Converts this PosLong to a Long.
def toOctalString: String
Permalink
Returns a string representation of this PosLong's underlying Long as an unsigned integer in base 8.
Returns a string representation of this PosLong's underlying Long as an unsigned integer in base 8.
The unsigned long value is this PosLong's underlying Long plus 2⁶⁴ if the underlying Long is negative; otherwise, it is equal to the underlying Long. This value is converted to a string of ASCII digits in octal (base 8) with no extra leading 0s.
If the unsigned magnitude is zero, it is represented by a single zero character '0' ('\u0030'); otherwise, the first character of the representation of the unsigned magnitude will not be the zero character. The following characters are used as octal digits:
01234567
These are the characters '\u0030' through '\u0037'.
returns
the string representation of the unsigned long value represented by this PosLong's underlying Long in octal (base 8).
def toShort: Short
Permalink
Converts this PosLong to a Short.
Converts this PosLong to a Short.
def toString(): String
Permalink
A string representation of this PosLong.
A string representation of this PosLong.

Definition Classes
PosLong → Any
def unary_+: PosLong
Permalink
Returns this value, unmodified.
def unary_-: Long
Permalink
Returns the negation of this value.
def unary_~: Long
Permalink
Returns the bitwise negation of this value.
Returns the bitwise negation of this value.
Example:
1. ~5 == -6 // in binary: ~00000101 == // 11111010
def until(end: Long, step: Long): Exclusive[Long]
Permalink
Create a Range from this PosLong value until the specified end (exclusive) with the specified step value.
Create a Range from this PosLong value until the specified end (exclusive) with the specified step value.
end
The final bound of the range to make.
step
The number to increase by for each step of the range.
returns
A scala.collection.immutable.NumericRange.Exclusive[Long] from this up to but not including end.
def until(end: Long): Exclusive[Long]
Permalink
Create a Range from this PosLong value until the specified end (exclusive) with step value 1.
Create a Range from this PosLong value until the specified end (exclusive) with step value 1.
end
The final bound of the range to make.
returns
A scala.collection.immutable.NumericRange.Exclusive[Long] from this up to but not including end.
val value: Long
Permalink
The Long value underlying this PosLong.
The Long value underlying this PosLong.
def |(x: Long): Long
Permalink
Returns the bitwise OR of this value and x.
Returns the bitwise OR of this value and x.
Example:
1. (0xf0 | 0xaa) == 0xfa // in binary: 11110000 // | 10101010 // -------- // 11111010
def |(x: Int): Long
Permalink
Returns the bitwise OR of this value and x.
Returns the bitwise OR of this value and x.
Example:
1. (0xf0 | 0xaa) == 0xfa // in binary: 11110000 // | 10101010 // -------- // 11111010
def |(x: Char): Long
Permalink
Returns the bitwise OR of this value and x.
Returns the bitwise OR of this value and x.
Example:
1. (0xf0 | 0xaa) == 0xfa // in binary: 11110000 // | 10101010 // -------- // 11111010
def |(x: Short): Long
Permalink
Returns the bitwise OR of this value and x.
Returns the bitwise OR of this value and x.
Example:
1. (0xf0 | 0xaa) == 0xfa // in binary: 11110000 // | 10101010 // -------- // 11111010
def |(x: Byte): Long
Permalink
Returns the bitwise OR of this value and x.
Returns the bitwise OR of this value and x.
Example:
1. (0xf0 | 0xaa) == 0xfa // in binary: 11110000 // | 10101010 // -------- // 11111010

PosLong

Related Docs: object PosLong | package anyvals

final class PosLong extends AnyVal

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def %(x: Double): Double

def %(x: Float): Float

def %(x: Long): Long

def %(x: Int): Long

def %(x: Char): Long

def %(x: Short): Long

def %(x: Byte): Long

def &(x: Long): Long

def &(x: Int): Long

def &(x: Char): Long

def &(x: Short): Long

def &(x: Byte): Long

def *(x: Double): Double

def *(x: Float): Float

def *(x: Long): Long

def *(x: Int): Long

def *(x: Char): Long

def *(x: Short): Long

def *(x: Byte): Long

def +(x: Double): Double

def +(x: Float): Float

def +(x: Long): Long

def +(x: Int): Long

def +(x: Char): Long

def +(x: Short): Long

def +(x: Byte): Long

def +(x: String): String

def -(x: Double): Double

def -(x: Float): Float

def -(x: Long): Long

def -(x: Int): Long

def -(x: Char): Long

def -(x: Short): Long

def -(x: Byte): Long

def /(x: Double): Double

def /(x: Float): Float

def /(x: Long): Long

def /(x: Int): Long

def /(x: Char): Long

def /(x: Short): Long

def /(x: Byte): Long

def <(x: Double): Boolean

def <(x: Float): Boolean

def <(x: Long): Boolean

def <(x: Int): Boolean

def <(x: Char): Boolean

def <(x: Short): Boolean

def <(x: Byte): Boolean

def <<(x: Long): Long

def <<(x: Int): Long

def <=(x: Double): Boolean

def <=(x: Float): Boolean

def <=(x: Long): Boolean

def <=(x: Int): Boolean

def <=(x: Char): Boolean

def <=(x: Short): Boolean

def <=(x: Byte): Boolean

final def ==(arg0: Any): Boolean

def >(x: Double): Boolean

def >(x: Float): Boolean

def >(x: Long): Boolean

def >(x: Int): Boolean

def >(x: Char): Boolean

def >(x: Short): Boolean

def >(x: Byte): Boolean

def >=(x: Double): Boolean

def >=(x: Float): Boolean

def >=(x: Long): Boolean

def >=(x: Int): Boolean

def >=(x: Char): Boolean

def >=(x: Short): Boolean

def >=(x: Byte): Boolean

def >>(x: Long): Long

def >>(x: Int): Long