fj.data.fingertrees.Measured Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of functionaljava Show documentation

Functional Java is an open source library that supports closures for the Java programming language

There is a newer version: 5.0

package fj.data.fingertrees;

import fj.Monoid;
import fj.F;

/**
 * Determines how the elements of a tree are measured and how measures are summed. Consists of a monoid and a
 * measuring function. Different instances of this class will result in different behaviours for the tree.
 */
public final class Measured {
  private final Monoid m;
  private final F measure;

  private Measured(final Monoid m, final F measure) {
    this.m = m;
    this.measure = measure;
  }

  public static  Measured measured(final Monoid m, final F measure) {
    return new Measured(m, measure);
  }

  /**
   * Returns the monoid used to sum measures.
   *
   * @return the monoid used to sum measures.
   */
  public Monoid monoid() {
    return m;
  }

  /**
   * Returns the measuring function.
   *
   * @return the measuring function.
   */
  public F measure() {
    return measure;
  }

  /**
   * Measures a given element.
   *
   * @param a An element to measure.
   * @return the element's measurement.
   */
  public V measure(final A a) {
    return measure.f(a);
  }

  /**
   * Sums the given measurements with the monoid.
   *
   * @param a A measurement to add to another.
   * @param b A measurement to add to another.
   * @return The sum of the two measurements.
   */
  public V sum(final V a, final V b) {
    return m.sum(a, b);
  }

  /**
   * Returns the identity measurement for the monoid.
   *
   * @return the identity measurement for the monoid.
   */
  public V zero() {
    return m.zero();
  }

  /**
   * A measured instance for nodes.
   *
   * @return A measured instance for nodes.
   */
  public Measured> nodeMeasured() {
    return new Measured>(m, new F, V>() {
      public V f(final Node node) {
        return node.measure();
      }
    });
  }

  /**
   * A measured instance for digits.
   *
   * @return A measured instance for digits.
   */
  public Measured> digitMeasured() {
    return new Measured>(m, new F, V>() {
      public V f(final Digit d) {
        return d.measure();
      }
    });
  }

}