spire.example.endoring.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of examples_2.10 Show documentation
examples
The newest version!
package spire.example

import language.implicitConversions

import spire.algebra._
import spire.implicits._
import spire.math._

object EndoRingExample extends App {

  // An abelian group is a commutative monoid with an inverse.
  trait AbGroup[A] extends Group[A]

  object AbGroup {
    implicit object IntAbGroup extends AbGroup[Int] {
      def op(a: Int, b: Int): Int = a + b
      def inverse(a: Int): Int = -a
      def id: Int = 0
    }

    /**
     * This turns the group of Sets under union into an abelian group by
     * keeping track of the inclusions and exclusions separately. This let's
     * us ensure it is commutative and that we always have an inverse.
     */
    implicit def PairedSetAbGroup[A] = new AbGroup[(Set[A], Set[A])] {
      def op(a: (Set[A], Set[A]), b: (Set[A], Set[A])): (Set[A], Set[A]) = {
        val (a1, a2) = a
        val (b1, b2) = b
        ((a1 -- b2) union (b1 -- a2), (a2 -- b1) union (b2 -- a1))
      }
      def inverse(a: (Set[A], Set[A])): (Set[A], Set[A]) = (a._2, a._1)
      def id: (Set[A], Set[A]) = (Set.empty, Set.empty)
    }
  }

  implicit def set2pairedSet[A](a: Set[A]): (Set[A], Set[A]) = (a, Set.empty)
  implicit def pairedSet2set[A](a: (Set[A], Set[A])): Set[A] = a._1 -- a._2

  // A (not very strict) endomorphism.
  type Endo[A] = A => A

  /**
   * Toy example of a non-numeric Ring. This constructs the endomorphism ring
   * for an abelian group `ab`. This defines addition as group addition after
   * applying the endomorphism and multiplication as composition.
   */
  class EndoRing[A:AbGroup] extends Ring[Endo[A]] {
    def plus(f: Endo[A], g: Endo[A]): Endo[A] = a => f(a) |+| g(a)
    def negate(f: Endo[A]): Endo[A] = a => f(a).inverse
    def times(f: Endo[A], g: Endo[A]): Endo[A] = a => f(g(a))

    // Identity endomorphism.
    def one: Endo[A] = a => a

    // Endomorphism to the trivial group.
    def zero: Endo[A] = a => Group[A].id
  }

  object EndoRing {
    def apply[A: AbGroup] = new EndoRing[A]
  }

  implicit val intEndoRing = EndoRing[Int]

  // Now we can treat Int => Int functions as a Ring. It obeys all the rules
  // you expect from a Ring, like distributivity. Of course, the
  // "endomorphisms" should map to valid abelian groups. With the Ints, we
  // can multiply by a constant.

  val x2: Int => Int = _ * 2
  val x3: Int => Int = _ * 3
  val inv: Int => Int = -_

  val a = (x2 + inv) * x3
  val b = (x2 * x3) + (inv * x3)

  (0 until 10).foreach(i => assert(a(i) == b(i))) // EndoRing is distributive.

  // What's more, we can recreate an Int ring by applying the Endo[Int]
  // with the id (1).

  val one = Ring[Int => Int].one
  val two = one + one
  val five = two * two + one
  (0 until 10).foreach { i =>
    assert(five(i) == 5 * i)
    assert(((five * two) + two)(i) == 12 * i)
  }

  implicit val pairedSetEndoRing = EndoRing[(Set[Int], Set[Int])]

  type PairedSet[A] = (Set[A], Set[A])

  // We can define some simple endomorphisms.
  val id = pairedSetEndoRing.one
  val double: Endo[PairedSet[Int]] = _ map (_ * 2)
  val triple: Endo[PairedSet[Int]] = _ map (_ * 3)
  val inc: Endo[PairedSet[Int]] = _ map (_ + 1)

  // Let's generate the powers of 2 from 0 to n. The endomorphism
  // `double + id` means that we double the elements of a set, then union it
  // with the original.
  val powers: Set[Int] = ((double + id) ** 3)(Set(1))
  assert(powers == Set(1, 2, 4, 8))

  val range: Set[Int] = ((inc + id) ** 4)(Set(1, 11))
  assert(range == Set(1, 2, 3, 4, 5, 11, 12, 13, 14, 15))

  // It's distributive.
  val q = Set(1,2,3)
  val e1 = (double + triple) * triple
  val e2 = (double * triple) + (triple * triple)
  assert(e1(q) == e2(q))
}