scalaz.BooleanW.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalaz-core_2.9.1 Show documentation
scalaz-core
The newest version!
package scalaz

sealed trait BooleanW {
  val isTrue: Boolean

  import Scalaz._
  
  def |∧| : BooleanConjunction = conjunction(isTrue)

  /**
   * Conjunction. (AND)
   *
   *    * p q  p ∧ q
   * 0 0  0
   * 0 1  0
   * 1 0  0
   * 1 1  1
   * 
   */
  def ∧(q: => BooleanW) = isTrue && q.isTrue

  /**
   * Disjunction. (OR)
   *
   *    * p q  p ∨ q
   * 0 0  0
   * 0 1  1
   * 1 0  1
   * 1 1  1
   * 
   */
  def ∨(q: => BooleanW) = isTrue || q.isTrue

  /**
   * Negation of Conjunction. (NOR)
   *
   *    * p q  p ⊽ q
   * 0 0  1
   * 0 1  1
   * 1 0  1
   * 1 1  0
   * 
   */
  def ⊽(q: => BooleanW) = !isTrue || !q.isTrue

  /**
   * Negation of Disjunction. (NAND)
   *
   *    * p q  p ⊼ q
   * 0 0  1
   * 0 1  0
   * 1 0  0
   * 1 1  0
   * 
   */
  def ⊼(q: => BooleanW) = !isTrue && !q.isTrue

  /**
   * Conditional.
   *
   *    * p q  p → q
   * 0 0  1
   * 0 1  1
   * 1 0  0
   * 1 1  1
   * 
   */
  def →(q: => BooleanW) = !isTrue || q.isTrue

  /**
   * Inverse Conditional.
   *
   *    * p q  p ⇐ q
   * 0 0  1
   * 0 1  0
   * 1 0  1
   * 1 1  1
   * 
   */
  def ⇐(q: => BooleanW) = isTrue || !q.isTrue

  /**
   * Negational of Conditional.
   *
   *    * p q  p ⇏ q
   * 0 0  0
   * 0 1  0
   * 1 0  1
   * 1 1  0
   * 
   */
  def ⇏(q: => BooleanW) = isTrue && !q.isTrue

  /**
   * Negation of Inverse Conditional.
   *
   *    * p q  p ⇍ q
   * 0 0  0
   * 0 1  1
   * 1 0  0
   * 1 1  0
   * 
   */
  def ⇍(q: => BooleanW) = !isTrue && q.isTrue

  /**
   * Executes the given side-effect if this boolean value is true.
   */
  def !(t: => Unit) = if(isTrue) t

  /**
   * Executes the given side-effect if this boolean value is false.
   */
  def unless(f: => Unit) = if(!isTrue) f

  /**
   * Executes the given side-effect if this boolean value is true.
   */
  def when(f: => Unit) = if(isTrue) f

  /**
   * @return `a` if true, `b` otherwise
   */
  def fold[A](a: => A, b: => A): A = if (isTrue) a else b

  trait Conditional[X] {
    def |(f: => X): X
  }

  /**
   * Conditional operator that returns the first argument if this is true, the second argument otherwise.
   */
  def ?[X](t: => X) = new Conditional[X] {
    def |(f: => X) = if(isTrue) t else f
  }

  /**
   * Returns the given argument in Some if this is true, None otherwise.
   */
  def option[A](a: => A) = if(isTrue) Some(a) else None

  trait ConditionalEither[A] {
    def or[B](b: => B): Either[A, B]
  }

  /**
   * Returns the first argument in Left if this is true, otherwise the second argument in
   * Right.
   */
  def either[A, B](a: => A) = new ConditionalEither[A] {
    def or[B](b: => B) = if(isTrue) Left(a) else Right(b)
  }

  /**
   * Returns the given argument if this is true, otherwise, the zero element for the type of the given
   * argument.
   */
  def ??[A: Zero](a: => A): A = if(isTrue) a else ∅

  def !?[A: Zero](a: => A): A = if(!isTrue) a else ∅

  trait GuardPrevent[M[_]] {
    def apply[A](a: => A)(implicit e: Empty[M], p: Pure[M]): M[A]
  }

  def guard[M[_]] = new GuardPrevent[M] {
    def apply[A](a: => A)(implicit e: Empty[M], p: Pure[M]) = if(isTrue) a η else <∅>
  }

  def prevent[M[_]] = new GuardPrevent[M] {
    def apply[A](a: => A)(implicit e: Empty[M], p: Pure[M]) = if(isTrue) <∅> else a η
  }
}

trait Booleans {
  implicit def BooleanTo(b: Boolean): BooleanW = new BooleanW {
    val isTrue = b
  }

  implicit def BooleanFrom(b: BooleanW): Boolean = b.isTrue
}