Power (Vectorz 0.62.0 API)

java.lang.Object
- mikera.vectorz.Op
- - mikera.vectorz.ops.Power

All Implemented Interfaces:

IOperator
```
public final class Power
extends Op
```

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`apply(double x)` Applies this operator to a single value, returning the result
`double`	`applyInverse(double x)` Applies the inverse of this Op.
`void`	`applyTo(AMatrix a)` Applies this operator to every element of a target matrix, mutating the matrix
`void`	`applyTo(AVector a)` Applies this operator to a mutable vector.
`void`	`applyTo(double[] data, int start, int length)` Applies this operator to the specified range within a double[] array.
`void`	`applyTo(INDArray a)` Applies this operator to every element of a target array.
`double`	`averageValue()`
`static Op`	`create(double exponent)`
`static Op`	`create(double exponent, double factor)`
`double`	`derivative(double x)` Returns the derivative of this Op for a given input value x i.e.
`double`	`derivativeForOutput(double y)` Returns the derivative of this Op for a given output value y i.e.
`Op`	`getDerivativeOp()` Gets an operator which represents the derivative of this operator.
`double`	`getExponent()`
`Op`	`getInverse()` Gets the inverse of this operator.
`boolean`	`hasDerivative()` Returns true if this operator supports computing the derivative for a given input
`boolean`	`hasInverse()` Returns true if this operator supports computing the inverse for a given output
`double`	`minDomain()`

Methods inherited from class mikera.vectorz.Op
applyTo, applyTo, applyTo, applyTo, applyTo, compose, compose, constrainValues, divide, getTransform, hasDerivativeForOutput, isBounded, isDomainBounded, isStochastic, maxDomain, maxValue, minValue, product, sum, toString, validateOutput

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - create
```
public static Op create(double exponent)
```
  - create
```
public static Op create(double exponent,
                        double factor)
```
  - minDomain
```
public double minDomain()
```
    Overrides:
    
    minDomain in class Op
  - apply
```
public double apply(double x)
```
    Description copied from interface: IOperator
    
    Applies this operator to a single value, returning the result
    
    Specified by:
    
    apply in interface IOperator
    
    Specified by:
    
    apply in class Op
    
    Returns:
  - applyTo
```
public void applyTo(INDArray a)
```
    Description copied from class: Op
    
    Applies this operator to every element of a target array. Mutates the array in place.
    
    Overrides:
    
    applyTo in class Op
  - applyTo
```
public void applyTo(AMatrix a)
```
    Description copied from class: Op
    
    Applies this operator to every element of a target matrix, mutating the matrix
    
    Overrides:
    
    applyTo in class Op
  - applyTo
```
public void applyTo(AVector a)
```
    Description copied from interface: IOperator
    
    Applies this operator to a mutable vector.
    
    Specified by:
    
    applyTo in interface IOperator
    
    Overrides:
    
    applyTo in class Op
  - applyTo
```
public void applyTo(double[] data,
                    int start,
                    int length)
```
    Description copied from interface: IOperator
    
    Applies this operator to the specified range within a double[] array.
    
    Specified by:
    
    applyTo in interface IOperator
    
    Overrides:
    
    applyTo in class Op
  - applyInverse
```
public double applyInverse(double x)
```
    Description copied from class: Op
    
    Applies the inverse of this Op. Throws an error if the inverse function does not exist. Returns Double.NaN if no inverse exists for the specific value of y.
    
    Overrides:
    
    applyInverse in class Op
    
    Returns:
  - hasDerivative
```
public boolean hasDerivative()
```
    Description copied from class: Op
    
    Returns true if this operator supports computing the derivative for a given input
    
    Overrides:
    
    hasDerivative in class Op
    
    Returns:
  - derivative
```
public double derivative(double x)
```
    Description copied from class: Op
    
    Returns the derivative of this Op for a given input value x i.e. f'(x) where f is the operator
    
    Overrides:
    
    derivative in class Op
    
    Returns:
  - derivativeForOutput
```
public double derivativeForOutput(double y)
```
    Description copied from class: Op
    
    Returns the derivative of this Op for a given output value y i.e. f'(g(y)) where f is the operator, g is the inverse of f
    
    Overrides:
    
    derivativeForOutput in class Op
    
    Returns:
  - getDerivativeOp
```
public Op getDerivativeOp()
```
    Description copied from class: Op
    
    Gets an operator which represents the derivative of this operator. Returns nil if this cannot be computed or does not exist.
    
    Overrides:
    
    getDerivativeOp in class Op
    
    Returns:
  - hasInverse
```
public boolean hasInverse()
```
    Description copied from class: Op
    
    Returns true if this operator supports computing the inverse for a given output
    
    Overrides:
    
    hasInverse in class Op
    
    Returns:
  - getInverse
```
public Op getInverse()
```
    Description copied from interface: IOperator
    
    Gets the inverse of this operator. Returns null if no inverse exists.
    
    Specified by:
    
    getInverse in interface IOperator
    
    Overrides:
    
    getInverse in class Op
    
    Returns:
  - averageValue
```
public double averageValue()
```
    Overrides:
    
    averageValue in class Op
  - getExponent
```
public double getExponent()
```

Class Power

Method Summary

Methods inherited from class mikera.vectorz.Op

Methods inherited from class java.lang.Object

Method Detail

create

create

minDomain

apply

applyTo

applyTo

applyTo

applyTo

applyInverse

hasDerivative

derivative

derivativeForOutput

getDerivativeOp

hasInverse

getInverse

averageValue

getExponent