Package ffx.numerics.switching

Class SquaredTrigSwitch

java.lang.Object
ffx.numerics.switching.SquaredTrigSwitch
All Implemented Interfaces:
UnivariateDiffFunction, UnivariateSwitchingFunction
public class SquaredTrigSwitch extends Object implements UnivariateSwitchingFunction
A SquaredTrigSwitch implements a 0-1 switch of form f(x) = sin^2(ax) or of form f(x) = cos^2(ax). Cosine implementation is achieved by phase-shifting a sine wave.
Author:
Jacob M. Litman, Michael J. Schnieders

  • Constructor Details

    • SquaredTrigSwitch

      public SquaredTrigSwitch(boolean cosine)
      Default constructor, creating a switch sin^2(pi*x/2), or cos^2 if flag set. The sine form will switch 0-1, and the cosine form switch 1-0.
      Parameters:
      cosine - Use a cos^2(pi*x/2) transform instead of sin^2(pi*x/2).

    • SquaredTrigSwitch

      public SquaredTrigSwitch(double coefficient, boolean cosine)
      Constructor permitting a custom frequency "a" in the form sin^2(a*x) or cos^2(a*x). The sine form will switch 0-1, and the cosine form switch 1-0.
      Parameters:
      coefficient - Value of a
      cosine - Use a cos^2(ax) transform instead of sin^2(ax).

  • Method Details

    • constantOutsideBounds

      public boolean constantOutsideBounds()
      Remains 0 below the lower bound, and 1 above the upper bound (i.e. a multiplicative switch).
      Specified by:
      constantOutsideBounds in interface UnivariateSwitchingFunction
      Returns:
      df(x)/dx is zero outside range lb-ub.

    • firstDerivative

      public double firstDerivative(double x) throws IllegalArgumentException
      First derivative at a point.
      Specified by:
      firstDerivative in interface UnivariateDiffFunction
      Parameters:
      x - a double.
      Returns:
      f'(x)
      Throws:
      IllegalArgumentException - If f'(x) is undefined at x.

    • getHighestOrderZeroDerivative

      public int getHighestOrderZeroDerivative()
      The highest-order derivative that is zero at the bounds.
      Specified by:
      getHighestOrderZeroDerivative in interface UnivariateSwitchingFunction
      Returns:
      Maximum order zero derivative at bounds.

    • getOneBound

      public double getOneBound()
      Gets the one bound, where f(x) becomes one.
      Specified by:
      getOneBound in interface UnivariateSwitchingFunction
      Returns:
      One bound

    • getPeriod

      public double getPeriod()
      Get the repeating period of this switch.
      Returns:
      Period

    • getZeroBound

      public double getZeroBound()
      Gets the zero bound, where f(x) becomes zero.
      Specified by:
      getZeroBound in interface UnivariateSwitchingFunction
      Returns:
      Zero bound

    • isCosine

      public boolean isCosine()
      Return true if a cos^2(ax) transform, false if a sin^2(ax) transform.
      Returns:
      a boolean.

    • nthDerivative

      public double nthDerivative(double x, int order) throws IllegalArgumentException
      N'th order derivative at a point. Should be relatively optional for any order above 2.
      Specified by:
      nthDerivative in interface UnivariateDiffFunction
      Parameters:
      x - a double.
      order - Derivative order (>= 1)
      Returns:
      d^nf(x)/dx^n
      Throws:
      IllegalArgumentException - If derivative undefined at x.

    • secondDerivative

      public double secondDerivative(double x) throws IllegalArgumentException
      Second derivative at a point.
      Specified by:
      secondDerivative in interface UnivariateDiffFunction
      Parameters:
      x - a double.
      Returns:
      f''(x)
      Throws:
      IllegalArgumentException - If f''(x) is undefined at x.

    • symmetricToUnity

      public boolean symmetricToUnity()
      True if f(lb + delta) + f(ub - delta) = 1 for all delta between 0 and (ub - lb). For example, a power switch with beta 1 is symmetric to unity, as f(l) + f(1-l) = 1, but beta 2 produces a non-unity result, where f(0.5) + f(0.5) = 0.5.
      Specified by:
      symmetricToUnity in interface UnivariateSwitchingFunction
      Returns:
      If symmetry produces unity result.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validOutsideBounds

      public boolean validOutsideBounds()
      Remains in the range 0-1 outside the bounds. Implied to be true if constantOutsideBounds is true.
      Specified by:
      validOutsideBounds in interface UnivariateSwitchingFunction
      Returns:
      min(f ( x)) = 0 and max(f(x)) = 1.

    • valueAt

      public double valueAt(double x) throws IllegalArgumentException
      Value at a point
      Specified by:
      valueAt in interface UnivariateDiffFunction
      Parameters:
      x - a double.
      Returns:
      f(x)
      Throws:
      IllegalArgumentException - If f(x) is undefined at x.