org.scalactic.anyvals.PosLong.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2001-2014 Artima, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.scalactic.anyvals

import scala.language.implicitConversions
import scala.collection.immutable.NumericRange

/**
 * 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.
 * 
 *
 * @param value The Long value underlying this PosLong.
 */ 
final class PosLong private (val value: Long) extends AnyVal {

  /**
   * A string representation of this PosLong.
   */
  override def toString: String = s"PosLong($value)"

  /**
   * Converts this PosLong to a Byte.
   */
  def toByte: Byte = value.toByte

  /**
   * Converts this PosLong to a Short.
   */
  def toShort: Short = value.toShort

  /**
   * Converts this PosLong to a Char.
   */
  def toChar: Char = value.toChar

  /**
   * Converts this PosLong to an Int.
   */
  def toInt: Int = value.toInt

  /**
   * Converts this PosLong to a Long.
   */
  def toLong: Long = value.toLong

  /**
   * Converts this PosLong to a Float.
   */
  def toFloat: Float = value.toFloat

  /**
   * Converts this PosLong to a Double.
   */
  def toDouble: Double = value.toDouble

 /**
 * Returns the bitwise negation of this value.
 * @example {{{
 * ~5 == -6
 * // in binary: ~00000101 ==
 * //             11111010
 * }}}
 */
  def unary_~ : Long = ~value
  /** Returns this value, unmodified. */
  def unary_+ : PosLong = this
  /** Returns the negation of this value. */
  def unary_- : Long = -value

  /**
   * Converts this PosLong's value to a string then concatenates the given string.
   */
  def +(x: String): String = value + x

  /**
  * Returns this value bit-shifted left by the specified number of bits,
  *         filling in the new right bits with zeroes.
  * @example {{{ 6 << 3 == 48 // in binary: 0110 << 3 == 0110000 }}}
  */
  def <<(x: Int): Long = value << x
  /**
  * Returns this value bit-shifted left by the specified number of bits,
  *         filling in the new right bits with zeroes.
  * @example {{{ 6 << 3 == 48 // in binary: 0110 << 3 == 0110000 }}}
  */
  def <<(x: Long): Long = value << x
  /**
  * Returns this value bit-shifted right by the specified number of bits,
  *         filling the new left bits with zeroes.
  * @example {{{ 21 >>> 3 == 2 // in binary: 010101 >>> 3 == 010 }}}
  * @example {{{
  * -21 >>> 3 == 536870909
  * // in binary: 11111111 11111111 11111111 11101011 >>> 3 ==
  * //            00011111 11111111 11111111 11111101
  * }}}
  */
  def >>>(x: Int): Long = value >>> x
  /**
  * Returns this value bit-shifted right by the specified number of bits,
  *         filling the new left bits with zeroes.
  * @example {{{ 21 >>> 3 == 2 // in binary: 010101 >>> 3 == 010 }}}
  * @example {{{
  * -21 >>> 3 == 536870909
  * // in binary: 11111111 11111111 11111111 11101011 >>> 3 ==
  * //            00011111 11111111 11111111 11111101
  * }}}
  */
  def >>>(x: Long): Long = value >>> x
  /**
  * 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 {{{
  * -21 >> 3 == -3
  * // in binary: 11111111 11111111 11111111 11101011 >> 3 ==
  * //            11111111 11111111 11111111 11111101
  * }}}
  */
  def >>(x: Int): Long = value >> x
  /**
  * 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 {{{
  * -21 >> 3 == -3
  * // in binary: 11111111 11111111 11111111 11101011 >> 3 ==
  * //            11111111 11111111 11111111 11111101
  * }}}
  */
  def >>(x: Long): Long = value >> x

  /** Returns `true` if this value is less than x, `false` otherwise. */
  def <(x: Byte): Boolean = value < x
  /** Returns `true` if this value is less than x, `false` otherwise. */
  def <(x: Short): Boolean = value < x
  /** Returns `true` if this value is less than x, `false` otherwise. */
  def <(x: Char): Boolean = value < x
  /** Returns `true` if this value is less than x, `false` otherwise. */
  def <(x: Int): Boolean = value < x
  /** Returns `true` if this value is less than x, `false` otherwise. */
  def <(x: Long): Boolean = value < x
  /** Returns `true` if this value is less than x, `false` otherwise. */
  def <(x: Float): Boolean = value < x
  /** Returns `true` if this value is less than x, `false` otherwise. */
  def <(x: Double): Boolean = value < x

  /** Returns `true` if this value is less than or equal to x, `false` otherwise. */
  def <=(x: Byte): Boolean = value <= x
  /** Returns `true` if this value is less than or equal to x, `false` otherwise. */
  def <=(x: Short): Boolean = value <= x
  /** Returns `true` if this value is less than or equal to x, `false` otherwise. */
  def <=(x: Char): Boolean = value <= x
  /** Returns `true` if this value is less than or equal to x, `false` otherwise. */
  def <=(x: Int): Boolean = value <= x
  /** Returns `true` if this value is less than or equal to x, `false` otherwise. */
  def <=(x: Long): Boolean = value <= x
  /** Returns `true` if this value is less than or equal to x, `false` otherwise. */
  def <=(x: Float): Boolean = value <= x
  /** Returns `true` if this value is less than or equal to x, `false` otherwise. */
  def <=(x: Double): Boolean = value <= x

  /** Returns `true` if this value is greater than x, `false` otherwise. */
  def >(x: Byte): Boolean = value > x
  /** Returns `true` if this value is greater than x, `false` otherwise. */
  def >(x: Short): Boolean = value > x
  /** Returns `true` if this value is greater than x, `false` otherwise. */
  def >(x: Char): Boolean = value > x
  /** Returns `true` if this value is greater than x, `false` otherwise. */
  def >(x: Int): Boolean = value > x
  /** Returns `true` if this value is greater than x, `false` otherwise. */
  def >(x: Long): Boolean = value > x
  /** Returns `true` if this value is greater than x, `false` otherwise. */
  def >(x: Float): Boolean = value > x
  /** Returns `true` if this value is greater than x, `false` otherwise. */
  def >(x: Double): Boolean = value > x

  /** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
  def >=(x: Byte): Boolean = value >= x
  /** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
  def >=(x: Short): Boolean = value >= x
  /** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
  def >=(x: Char): Boolean = value >= x
  /** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
  def >=(x: Int): Boolean = value >= x
  /** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
  def >=(x: Long): Boolean = value >= x
  /** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
  def >=(x: Float): Boolean = value >= x
  /** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
  def >=(x: Double): Boolean = value >= x

  /**
  * Returns the bitwise OR of this value and `x`.
  * @example {{{
  * (0xf0 | 0xaa) == 0xfa
  * // in binary:   11110000
  * //            | 10101010
  * //              --------
  * //              11111010
  * }}}
  */
  def |(x: Byte): Long = value | x
  /**
  * Returns the bitwise OR of this value and `x`.
  * @example {{{
  * (0xf0 | 0xaa) == 0xfa
  * // in binary:   11110000
  * //            | 10101010
  * //              --------
  * //              11111010
  * }}}
  */
  def |(x: Short): Long = value | x
  /**
  * Returns the bitwise OR of this value and `x`.
  * @example {{{
  * (0xf0 | 0xaa) == 0xfa
  * // in binary:   11110000
  * //            | 10101010
  * //              --------
  * //              11111010
  * }}}
  */
  def |(x: Char): Long = value | x
  /**
  * Returns the bitwise OR of this value and `x`.
  * @example {{{
  * (0xf0 | 0xaa) == 0xfa
  * // in binary:   11110000
  * //            | 10101010
  * //              --------
  * //              11111010
  * }}}
  */
  def |(x: Int): Long = value | x
  /**
  * Returns the bitwise OR of this value and `x`.
  * @example {{{
  * (0xf0 | 0xaa) == 0xfa
  * // in binary:   11110000
  * //            | 10101010
  * //              --------
  * //              11111010
  * }}}
  */
  def |(x: Long): Long = value | x

  /**
  * Returns the bitwise AND of this value and `x`.
  * @example {{{
  * (0xf0 & 0xaa) == 0xa0
  * // in binary:   11110000
  * //            & 10101010
  * //              --------
  * //              10100000
  * }}}
  */
  def &(x: Byte): Long = value & x
  /**
  * Returns the bitwise AND of this value and `x`.
  * @example {{{
  * (0xf0 & 0xaa) == 0xa0
  * // in binary:   11110000
  * //            & 10101010
  * //              --------
  * //              10100000
  * }}}
  */
  def &(x: Short): Long = value & x
  /**
  * Returns the bitwise AND of this value and `x`.
  * @example {{{
  * (0xf0 & 0xaa) == 0xa0
  * // in binary:   11110000
  * //            & 10101010
  * //              --------
  * //              10100000
  * }}}
  */
  def &(x: Char): Long = value & x
  /**
  * Returns the bitwise AND of this value and `x`.
  * @example {{{
  * (0xf0 & 0xaa) == 0xa0
  * // in binary:   11110000
  * //            & 10101010
  * //              --------
  * //              10100000
  * }}}
  */
  def &(x: Int): Long = value & x
  /**
  * Returns the bitwise AND of this value and `x`.
  * @example {{{
  * (0xf0 & 0xaa) == 0xa0
  * // in binary:   11110000
  * //            & 10101010
  * //              --------
  * //              10100000
  * }}}
  */
  def &(x: Long): Long = value & x

  /**
  * Returns the bitwise XOR of this value and `x`.
  * @example {{{
  * (0xf0 ^ 0xaa) == 0x5a
  * // in binary:   11110000
  * //            ^ 10101010
  * //              --------
  * //              01011010
  * }}}
  */
  def ^(x: Byte): Long = value ^ x
  /**
  * Returns the bitwise XOR of this value and `x`.
  * @example {{{
  * (0xf0 ^ 0xaa) == 0x5a
  * // in binary:   11110000
  * //            ^ 10101010
  * //              --------
  * //              01011010
  * }}}
  */
  def ^(x: Short): Long = value ^ x
  /**
  * Returns the bitwise XOR of this value and `x`.
  * @example {{{
  * (0xf0 ^ 0xaa) == 0x5a
  * // in binary:   11110000
  * //            ^ 10101010
  * //              --------
  * //              01011010
  * }}}
  */
  def ^(x: Char): Long = value ^ x
  /**
  * Returns the bitwise XOR of this value and `x`.
  * @example {{{
  * (0xf0 ^ 0xaa) == 0x5a
  * // in binary:   11110000
  * //            ^ 10101010
  * //              --------
  * //              01011010
  * }}}
  */
  def ^(x: Int): Long = value ^ x
  /**
  * Returns the bitwise XOR of this value and `x`.
  * @example {{{
  * (0xf0 ^ 0xaa) == 0x5a
  * // in binary:   11110000
  * //            ^ 10101010
  * //              --------
  * //              01011010
  * }}}
  */
  def ^(x: Long): Long = value ^ x

  /** Returns the sum of this value and `x`. */
  def +(x: Byte): Long = value + x
  /** Returns the sum of this value and `x`. */
  def +(x: Short): Long = value + x
  /** Returns the sum of this value and `x`. */
  def +(x: Char): Long = value + x
  /** Returns the sum of this value and `x`. */
  def +(x: Int): Long = value + x
  /** Returns the sum of this value and `x`. */
  def +(x: Long): Long = value + x
  /** Returns the sum of this value and `x`. */
  def +(x: Float): Float = value + x
  /** Returns the sum of this value and `x`. */
  def +(x: Double): Double = value + x

  /** Returns the difference of this value and `x`. */
  def -(x: Byte): Long = value - x
  /** Returns the difference of this value and `x`. */
  def -(x: Short): Long = value - x
  /** Returns the difference of this value and `x`. */
  def -(x: Char): Long = value - x
  /** Returns the difference of this value and `x`. */
  def -(x: Int): Long = value - x
  /** Returns the difference of this value and `x`. */
  def -(x: Long): Long = value - x
  /** Returns the difference of this value and `x`. */
  def -(x: Float): Float = value - x
  /** Returns the difference of this value and `x`. */
  def -(x: Double): Double = value - x

  /** Returns the product of this value and `x`. */
  def *(x: Byte): Long = value * x
  /** Returns the product of this value and `x`. */
  def *(x: Short): Long = value * x
  /** Returns the product of this value and `x`. */
  def *(x: Char): Long = value * x
  /** Returns the product of this value and `x`. */
  def *(x: Int): Long = value * x
  /** Returns the product of this value and `x`. */
  def *(x: Long): Long = value * x
  /** Returns the product of this value and `x`. */
  def *(x: Float): Float = value * x
  /** Returns the product of this value and `x`. */
  def *(x: Double): Double = value * x

  /** Returns the quotient of this value and `x`. */
  def /(x: Byte): Long = value / x
  /** Returns the quotient of this value and `x`. */
  def /(x: Short): Long = value / x
  /** Returns the quotient of this value and `x`. */
  def /(x: Char): Long = value / x
  /** Returns the quotient of this value and `x`. */
  def /(x: Int): Long = value / x
  /** Returns the quotient of this value and `x`. */
  def /(x: Long): Long = value / x
  /** Returns the quotient of this value and `x`. */
  def /(x: Float): Float = value / x
  /** Returns the quotient of this value and `x`. */
  def /(x: Double): Double = value / x

  /** Returns the remainder of the division of this value by `x`. */
  def %(x: Byte): Long = value % x
  /** Returns the remainder of the division of this value by `x`. */
  def %(x: Short): Long = value % x
  /** Returns the remainder of the division of this value by `x`. */
  def %(x: Char): Long = value % x
  /** Returns the remainder of the division of this value by `x`. */
  def %(x: Int): Long = value % x
  /** Returns the remainder of the division of this value by `x`. */
  def %(x: Long): Long = value % x
  /** Returns the remainder of the division of this value by `x`. */
  def %(x: Float): Float = value % x
  /** Returns the remainder of the division of this value by `x`. */
  def %(x: Double): Double = value % x

  // Stuff from RichLong:
  /**
   * 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.
   * 
   *
   * @return  the string representation of the unsigned long
   *          value represented by this PosLong's underlying Long in binary (base 2).
   */
  def toBinaryString: String = java.lang.Long.toBinaryString(value)

  /**
   * 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.
   * 
   *
   * @return  the string representation of the unsigned long
   *          value represented by this PosLong's underlying Long in hexadecimal
   *          (base 16).
   */
  def toHexString: String = java.lang.Long.toHexString(value)

  /**
   * 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'.
   * 
   *
   * @return  the string representation of the unsigned long
   *          value represented by this PosLong's underlying Long in octal (base 8).
   */
  def toOctalString: String = java.lang.Long.toOctalString(value)

  // No point to call abs on a PosLong.
  /**
  * Returns this if this > that or that otherwise.
  */
  def max(that: PosLong): PosLong = if (math.max(value, that.value) == value) this else that

  /**
  * Returns this if this < that or that otherwise.
  */
  def min(that: PosLong): PosLong = if (math.min(value, that.value) == value) this else that

  // adapted from RichInt:
  /**
  * Create a Range from this PosLong value
  * until the specified end (exclusive) with step value 1.
  *
  * @param end The final bound of the range to make.
  * @return A [[scala.collection.immutable.NumericRange.Exclusive[Long]]] from `this` up to but
  * not including `end`.
  */
  def until(end: Long): NumericRange.Exclusive[Long] = value.until(end)

  /**
  * Create a Range from this PosLong value
  * until the specified end (exclusive) with the specified step value.
  *
  * @param end The final bound of the range to make.
  * @param end The final bound of the range to make.
  * @param step The number to increase by for each step of the range.
  * @return A [[scala.collection.immutable.NumericRange.Exclusive[Long]]] from `this` up to but
  * not including `end`.
  */
  def until(end: Long, step: Long): NumericRange.Exclusive[Long] =
    value.until(end, step)

  /**
  * Create an inclusive Range from this PosLong value
  * to the specified end with step value 1.
  *
  * @param end The final bound of the range to make.
  * @return A [[scala.collection.immutable.NumericRange.Inclusive[Long]]] from `'''this'''` up to
  * and including `end`.
  */
  def to(end: Long): NumericRange.Inclusive[Long] = value.to(end)

  /**
  * Create an inclusive Range from this PosLong value
  * to the specified end with the specified step value.
  *
  * @param end The final bound of the range to make.
  * @param step The number to increase by for each step of the range.
  * @return A [[scala.collection.immutable.NumericRange.Inclusive[Long]]] from `'''this'''` up to
  * and including `end`.
  */
  def to(end: Long, step: Long): NumericRange.Inclusive[Long] =
    value.to(end, step)
}

/**
 * The companion object for PosLong that offers
 * factory methods that produce PosLongs, implicit
 * widening conversions from PosLong to other
 * numeric types, and maximum and minimum constant values for
 * PosLong.
 */
object PosLong {
  /**
   * The largest value representable as a positive
   * Long, which is PosLong(9223372036854775807).
   */
  final val MaxValue: PosLong = PosLong.from(Long.MaxValue).get

  /**
   * The smallest value representable as a positive
   * Long, which is PosLong(1L).
   */
  final val MinValue: PosLong = PosLong.from(1L).get // Can't use the macro here

  /**
   * A factory method that produces an Option[PosLong] given a
   * Long value.
   *
   * 
   * This method will inspect the passed Long value and if
   * it is a positive Long, i.e., a value greater
   * than 0, it will return a PosLong representing that value,
   * wrapped in a Some. Otherwise, the passed Long
   * value is 0 or negative, so this method will return None.
   * 
   *
   * 
   * This factory method differs from the apply
   * factory method in that apply is implemented
   * via a macro that inspects Long literals at
   * compile time, whereas from inspects
   * Long values at run time.
   * 
   *
   * @param value the Long to inspect, and if positive, return
   *     wrapped in a Some[PosLong].
   * @return the specified Long value wrapped in a
   *     Some[PosLong], if it is positive, else
   *     None.
   */
  def from(value: Long): Option[PosLong] =
    if (value > 0L) Some(new PosLong(value)) else None

  import language.experimental.macros

  /**
   * A factory method, implemented via a macro, that produces a
   * PosLong if passed a valid Long
   * literal, otherwise a compile time error.
   *
   * 
   * The macro that implements this method will inspect the
   * specified Long expression at compile time. If
   * the expression is a positive Long literal,
   * i.e., with a value greater than 0, it will return
   * a PosLong representing that value.  Otherwise,
   * the passed Long expression is either a literal
   * that is 0 or negative, or is not a literal, so this method
   * will give a compiler error.
   * 
   *
   * 
   * This factory method differs from the from
   * factory method in that this method is implemented via a
   * macro that inspects Long literals at compile
   * time, whereas from inspects Long
   * values at run time.
   * 
   *
   * @param value the Long literal expression to
   *     inspect at compile time, and if positive, to return
   *     wrapped in a PosLong at run time.
   * @return the specified, valid Long literal
   *     value wrapped in a PosLong. (If the
   *     specified expression is not a valid Long
   *     literal, the invocation of this method will not
   *     compile.)
   */
  implicit def apply(value: Long): PosLong = macro PosLongMacro.apply

  /**
   * Implicit widening conversion from PosLong to
   * Long.
   *
   * @param pos the PosLong to widen
   * @return the Long value underlying the specified
   *     PosLong.
   */
  implicit def widenToLong(pos: PosLong): Long = pos.value

  /**
   * Implicit widening conversion from PosLong to
   * Float.
   *
   * @param pos the PosLong to widen
   * @return the Long value underlying the specified
   *     PosLong, widened to Float.
   */
  implicit def widenToFloat(pos: PosLong): Float = pos.value

  /**
   * Implicit widening conversion from PosLong to
   * Double.
   *
   * @param pos the PosLong to widen
   * @return the Long value underlying the specified
   *     PosLong, widened to Double.
   */
  implicit def widenToDouble(pos: PosLong): Double = pos.value

  /**
   * Implicit widening conversion from PosLong to
   * PosFloat.
   *
   * @param pos the PosLong to widen
   * @return the Long value underlying the specified
   *     PosLong, widened to Float and
   *     wrapped in a PosFloat.
   */
  implicit def widenToPosFloat(pos: PosLong): PosFloat = PosFloat.from(pos.value).get

  /**
   * Implicit widening conversion from PosLong to
   * PosDouble.
   *
   * @param pos the PosLong to widen
   * @return the Long value underlying the specified
   *     PosLong, widened to Double and
   *     wrapped in a PosDouble.
   */
  implicit def widenToPosDouble(pos: PosLong): PosDouble = PosDouble.from(pos.value).get

  /**
   * Implicit widening conversion from PosLong to
   * PosZLong.
   *
   * @param pos the PosLong to widen
   * @return the Long value underlying the specified
   *     PosLong wrapped in a PosZLong.
   */
  implicit def widenToPosZLong(pos: PosLong): PosZLong = PosZLong.from(pos.value).get

  /** 
   * Implicit widening conversion from PosLong to
   * PosZFloat.
   *
   * @param pos the PosLong to widen
   * @return the Long value underlying the specified
   *     PosLong, widened to Float and
   *     wrapped in a PosZFloat.
   */
  implicit def widenToPosZFloat(pos: PosLong): PosZFloat = PosZFloat.from(pos.value).get

  /** 
   * Implicit widening conversion from PosLong to
   * PosZDouble.
   *
   * @param pos the PosLong to widen
   * @return the Long value underlying the specified
   *     PosLong, widened to Double and
   *     wrapped in a PosZDouble.
   */
  implicit def widenToPosZDouble(pos: PosLong): PosZDouble = PosZDouble.from(pos.value).get

  /**
   * Implicit Ordering instance.
   */
  implicit val posLongOrd: Ordering[PosLong] =
    new Ordering[PosLong] {
      def compare(x: PosLong, y: PosLong): Int = x.toLong.compare(y)
    } 
}