Class UnaryRealTypeMath<I extends RealType<I>,​O extends RealType<O>>


  • public final class UnaryRealTypeMath<I extends RealType<I>,​O extends RealType<O>>
    extends Object
    Ops of the math namespace which operate on RealTypes.
    Author:
    Barry DeZonia, Jonathan Hale (University of Konstanz), Curtis Rueden
    • Field Summary

      Fields 
      Modifier and Type Field Description
      Computers.Arity1<I,​O> absoluteValue
      Sets the real component of an output real number to the absolute value of the real component of an input real number.
      Computers.Arity1<I,​O> arccos
      Sets the real component of an output real number to the inverse cosine of the real component of an input real number.
      Computers.Arity1<I,​O> arccosh
      Sets the real component of an output real number to the inverse hyperbolic cosine of the real component of an input real number.
      Computers.Arity1<I,​O> arccot
      Sets the real component of an output real number to the inverse cotangent of the real component of an input real number.
      Computers.Arity1<I,​O> arccoth
      Sets the real component of an output real number to the inverse hyperbolic cotangent of the real component of an input real number.
      Computers.Arity1<I,​O> arccsc
      Sets the real component of an output real number to the inverse cosecant of the real component of an input real number.
      Computers.Arity1<I,​O> arccsch
      Sets the real component of an output real number to the inverse hyperbolic cosecant of the real component of an input real number.
      Computers.Arity1<I,​O> arcsec
      Sets the real component of an output real number to the inverse secant of the real component of an input real number.
      Computers.Arity1<I,​O> arcsech
      Sets the real component of an output real number to the inverse hyperbolic secant of the real component of an input real number.
      Computers.Arity1<I,​O> arcsin
      Sets the real component of an output real number to the inverse sine of the real component of an input real number.
      Computers.Arity1<I,​O> arcsinh
      Sets the real component of an output real number to the inverse hyperbolic sine of the real component of an input real number.
      Computers.Arity1<I,​O> arctan
      Sets the real component of an output real number to the inverse tangent of the real component of an input real number.
      Computers.Arity1<I,​O> arctanh
      Sets the real component of an output real number to the inverse hyperbolic tangent of the real component of an input real number.
      Computers.Arity1<I,​O> ceil
      Sets the real component of an output real number to the ceiling of the real component of an input real number.
      Computers.Arity1<I,​O> cos
      Sets the real component of an output real number to the cosine of the real component of an input real number.
      Computers.Arity1<I,​O> cosh
      Sets the real component of an output real number to the hyperbolic cosine of the real component of an input real number.
      Computers.Arity1<I,​O> cot
      Sets the real component of an output real number to the cotangent of the real component of an input real number.
      Computers.Arity1<I,​O> coth
      Sets the real component of an output real number to the hyperbolic cotangent of the real component of an input real number.
      Computers.Arity1<I,​O> csc
      Sets the real component of an output real number to the cosecant of the real component of an input real number.
      Computers.Arity1<I,​O> csch
      Sets the real component of an output real number to the hyperbolic cosecant of the real component of an input real number.
      Computers.Arity1<I,​O> cubeRoot
      Sets the real component of an output real number to the cube root of the real component of an input real number.
      Computers.Arity1<I,​O> exp
      Sets the real component of an output real number to the exponentiation of the real component of an input real number.
      Computers.Arity1<I,​O> expMinusOne
      Sets the real component of an output real number to e^x - 1.
      Computers.Arity1<I,​O> floor
      Sets the real component of an output real number to the floor of the real component of an input real number.
      Computers.Arity2<I,​Double,​O> gamma
      Sets the real component of an output real number to the gamma value of the real component of an input real number.
      Computers.Arity2<I,​Integer,​I> intPower
      Uses ImgLib2 Mul interface to take a type to an integer power.
      Computers.Arity3<I,​Double,​Double,​O> invert
      Sets the real component of an output real number to the inversion of the real component of an input real number about a range.
      Computers.Arity1<I,​O> log
      Sets the real component of an output real number to the natural log of the real component of an input real number.
      Computers.Arity1<I,​O> log10
      Sets the real component of an output real number to the 10-based log of the real component of an input real number.
      Computers.Arity1<I,​O> log2
      Sets the real component of an output real number to the base 2 log of the real component of an input real number.
      Computers.Arity1<I,​O> logOnePlusX
      Sets the real component of an output real number to the natural logarithm of the sum of the argument and 1.
      Computers.Arity2<I,​Double,​O> max
      Sets the real component of an output real number to the real component of an input real number unless it exceeds a maximum value.
      Computers.Arity2<I,​Double,​O> min
      Sets the real component of an output real number to the real component of an input real number unless it is less then a minimum value.
      Computers.Arity1<I,​O> nearestInt
      Sets the real component of an output real number to the nearest integral value of the real component of an input real number.
      Computers.Arity1<I,​O> negate
      Sets the real component of an output real number to the negation of the real component of an input real number.
      Computers.Arity2<I,​Double,​O> power
      Sets the real component of an output real number to the raising of the real component of an input real number to a constant value.
      Computers.Arity2<I,​Double,​O> reciprocal
      Sets the real component of an output real number to the reciprocal of the real component of an input real number.
      Computers.Arity1<I,​O> round
      Sets the real component of an output real number to the rounding of the real component of an input real number.
      Computers.Arity1<I,​O> sec
      Sets the real component of an output real number to the secant of the real component of an input real number.
      Computers.Arity1<I,​O> sech
      Sets the real component of an output real number to the hyperbolic secant of the real component of an input real number.
      Computers.Arity1<I,​O> signum
      Sets the real component of an output real number to the signum of the real component of an input real number.
      Computers.Arity1<I,​O> sin
      Sets the real component of an output real number to the sine of the real component of an input real number.
      Computers.Arity1<I,​O> sinc
      Sets the real component of an output real number to the sinc value of the real component of an input real number.
      Computers.Arity1<I,​O> sincPi
      Sets the real component of an output real number to the sinc (pi version) of the real component of an input real number.
      Computers.Arity1<I,​O> sinh
      Sets the real component of an output real number to the hyperbolic sine of the real component of an input real number.
      Computers.Arity1<I,​O> sqrt
      Sets the real component of an output real number to the square root of the real component of an input real number.
      Computers.Arity1<I,​O> square
      Sets the real component of an output real number to the square of the real component of an input real number.
      Computers.Arity1<I,​O> step
      Sets an output real number to 0 if the input real number is less than 0.
      Computers.Arity1<I,​O> tan
      Sets the real component of an output real number to the tangent of the real component of an input real number.
      Computers.Arity1<I,​O> tanh
      Sets the real component of an output real number to the hyperbolic tangent of the real component of an input real number.
      Computers.Arity1<I,​O> ulp
      Sets the real component of an output real number to the size of the ulp of an input real number.
    • Field Detail

      • absoluteValue

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> absoluteValue
        Sets the real component of an output real number to the absolute value of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.abs'
      • arccos

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arccos
        Sets the real component of an output real number to the inverse cosine of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arccos'
      • arccosh

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arccosh
        Sets the real component of an output real number to the inverse hyperbolic cosine of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arccosh'
      • arccot

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arccot
        Sets the real component of an output real number to the inverse cotangent of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arccot'
      • arccoth

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arccoth
        Sets the real component of an output real number to the inverse hyperbolic cotangent of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arccoth'
      • arccsc

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arccsc
        Sets the real component of an output real number to the inverse cosecant of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arccsc'
      • arccsch

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arccsch
        Sets the real component of an output real number to the inverse hyperbolic cosecant of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arccsch'
      • arcsec

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arcsec
        Sets the real component of an output real number to the inverse secant of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arcsec'
      • arcsech

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arcsech
        Sets the real component of an output real number to the inverse hyperbolic secant of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arcsech'
      • arcsin

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arcsin
        Sets the real component of an output real number to the inverse sine of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arcsin'
      • arcsinh

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arcsinh
        Sets the real component of an output real number to the inverse hyperbolic sine of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arcsinh'
      • arctan

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arctan
        Sets the real component of an output real number to the inverse tangent of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arctan'
      • arctanh

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> arctanh
        Sets the real component of an output real number to the inverse hyperbolic tangent of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.arctanh'
      • ceil

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> ceil
        Sets the real component of an output real number to the ceiling of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.ceil'
      • cos

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> cos
        Sets the real component of an output real number to the cosine of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.cos'
      • cosh

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> cosh
        Sets the real component of an output real number to the hyperbolic cosine of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.cosh'
      • cot

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> cot
        Sets the real component of an output real number to the cotangent of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.cot'
      • coth

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> coth
        Sets the real component of an output real number to the hyperbolic cotangent of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.coth'
      • csc

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> csc
        Sets the real component of an output real number to the cosecant of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.csc'
      • csch

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> csch
        Sets the real component of an output real number to the hyperbolic cosecant of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.csch'
      • cubeRoot

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> cubeRoot
        Sets the real component of an output real number to the cube root of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.cubeRoot'
      • exp

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> exp
        Sets the real component of an output real number to the exponentiation of the real component of an input real number. (e raised to a power)
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.exp'
      • expMinusOne

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> expMinusOne
        Sets the real component of an output real number to e^x - 1. x is the input argument to the operation.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.expMinusOne'
      • floor

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> floor
        Sets the real component of an output real number to the floor of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.floor'
      • gamma

        public final Computers.Arity2<I extends RealType<I>,​Double,​O extends RealType<O>> gamma
        Sets the real component of an output real number to the gamma value of the real component of an input real number.
        Input parameters:
        input
        constant
        Container parameters:
        output
        Implementation Note:
        op names='math.gamma'
      • invert

        public final Computers.Arity3<I extends RealType<I>,​Double,​Double,​O extends RealType<O>> invert
        Sets the real component of an output real number to the inversion of the real component of an input real number about a range.
        Input parameters:
        input
        specifiedMin
        specifiedMax
        Container parameters:
        output
        Implementation Note:
        op names='math.invert'
      • log

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> log
        Sets the real component of an output real number to the natural log of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.log'
      • log10

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> log10
        Sets the real component of an output real number to the 10-based log of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.log10'
      • log2

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> log2
        Sets the real component of an output real number to the base 2 log of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.log2'
      • logOnePlusX

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> logOnePlusX
        Sets the real component of an output real number to the natural logarithm of the sum of the argument and 1. This calculation is more accurate than explicitly calling log(1.0 + x).
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.logOnePlusX'
      • max

        public final Computers.Arity2<I extends RealType<I>,​Double,​O extends RealType<O>> max
        Sets the real component of an output real number to the real component of an input real number unless it exceeds a maximum value. If it exceeds the maximum value then it sets the output real component to that maximum value.
        Input parameters:
        input
        constant
        Container parameters:
        output
        Implementation Note:
        op names='math.max'
      • min

        public final Computers.Arity2<I extends RealType<I>,​Double,​O extends RealType<O>> min
        Sets the real component of an output real number to the real component of an input real number unless it is less then a minimum value. If it is less than the minimum value then it sets the output real component to that minimum value.
        Input parameters:
        input
        constant
        Container parameters:
        output
        Implementation Note:
        op names='math.min'
      • nearestInt

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> nearestInt
        Sets the real component of an output real number to the nearest integral value of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.nearestInt'
      • negate

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> negate
        Sets the real component of an output real number to the negation of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.negate'
      • power

        public final Computers.Arity2<I extends RealType<I>,​Double,​O extends RealType<O>> power
        Sets the real component of an output real number to the raising of the real component of an input real number to a constant value.
        Input parameters:
        input
        constant
        Container parameters:
        output
        Implementation Note:
        op names='math.power'
      • intPower

        public final Computers.Arity2<I extends RealType<I>,​Integer,​I extends RealType<I>> intPower
        Uses ImgLib2 Mul interface to take a type to an integer power.
        Input parameters:
        input
        constant
        Container parameters:
        output
        Implementation Note:
        op names='math.power'
      • reciprocal

        public final Computers.Arity2<I extends RealType<I>,​Double,​O extends RealType<O>> reciprocal
        Sets the real component of an output real number to the reciprocal of the real component of an input real number.
        Input parameters:
        input
        divideByZeroValue
        Container parameters:
        output
        Implementation Note:
        op names='math.reciprocal'
      • round

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> round
        Sets the real component of an output real number to the rounding of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.round'
      • sec

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> sec
        Sets the real component of an output real number to the secant of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.sec'
      • sech

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> sech
        Sets the real component of an output real number to the hyperbolic secant of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.sech'
      • signum

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> signum
        Sets the real component of an output real number to the signum of the real component of an input real number. It equals -1 if the input number is less than 0, it equals 1 if the input number is greater than 0, and it equals 0 if the input number equals 0.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.signum'
      • sin

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> sin
        Sets the real component of an output real number to the sine of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.sin'
      • sinc

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> sinc
        Sets the real component of an output real number to the sinc value of the real component of an input real number. The sinc function is defined as sin(x) / x.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.sinc'
      • sincPi

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> sincPi
        Sets the real component of an output real number to the sinc (pi version) of the real component of an input real number. The pi version of sinc is defined as sin(x*pi) / (x*pi).
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.sincPi'
      • sinh

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> sinh
        Sets the real component of an output real number to the hyperbolic sine of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.sinh'
      • square

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> square
        Sets the real component of an output real number to the square of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.sqr'
      • sqrt

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> sqrt
        Sets the real component of an output real number to the square root of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.sqrt'
      • step

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> step
        Sets an output real number to 0 if the input real number is less than 0. Otherwise sets the output real number to 1. This implements a step function similar to Mathematica's unitstep function. It is a Heaviside step function with h(0) = 1 rather than 0.5.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.step'
      • tan

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> tan
        Sets the real component of an output real number to the tangent of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.tan'
      • tanh

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> tanh
        Sets the real component of an output real number to the hyperbolic tangent of the real component of an input real number.
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.tanh'
      • ulp

        public final Computers.Arity1<I extends RealType<I>,​O extends RealType<O>> ulp
        Sets the real component of an output real number to the size of the ulp of an input real number. An ulp of a floating point value is the positive distance between an input floating-point value and the floating point value next larger in magnitude. Note that for non-NaN x, ulp(-x) == ulp(x).
        Input parameters:
        input
        Container parameters:
        output
        Implementation Note:
        op names='math.ulp'
    • Constructor Detail

      • UnaryRealTypeMath

        public UnaryRealTypeMath()