cc.redberry.core.transformations

Class DifferentiateTransformation

java.lang.Object

cc.redberry.core.transformations.DifferentiateTransformation

All Implemented Interfaces:

Transformation

public final class DifferentiateTransformation
extends java.lang.Object
implements Transformation

Differentiates specified tensor with respect to specified simple tensors. It temporary does not support derivatives of tensor fields.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface cc.redberry.core.transformations.Transformation

Transformation.Util

Field Summary

Fields inherited from interface cc.redberry.core.transformations.Transformation

INDENTITY

Constructor Summary

Constructors

Constructor and Description
DifferentiateTransformation(SimpleTensor... vars) Creates transformations which differentiate with respect to specified simple tensors.
DifferentiateTransformation(SimpleTensor[] vars, Transformation[] expandAndContract)

Method Summary

Modifier and Type	Method and Description
static Tensor	differentiate(Tensor tensor, SimpleTensor... vars) Gives the multiple derivative of specified tensor with respect to specified arguments.
static Tensor	differentiate(Tensor tensor, SimpleTensor var, int order) Gives the multiple derivative of specified order of specified tensor with respect to specified simple tensor.
static Tensor	differentiate(Tensor tensor, Transformation[] expandAndContract, SimpleTensor... vars) Gives the multiple derivative of specified tensor with respect to specified arguments.
Tensor	transform(Tensor t) Transforms specified tensor and returns the result.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DifferentiateTransformation

public DifferentiateTransformation(SimpleTensor... vars)

Creates transformations which differentiate with respect to specified simple tensors.

Parameters:

vars -

DifferentiateTransformation

public DifferentiateTransformation(SimpleTensor[] vars,
                                   Transformation[] expandAndContract)

Method Detail

transform

public Tensor transform(Tensor t)

Description copied from interface: Transformation

Transforms specified tensor and returns the result.

Specified by:

transform in interface Transformation

Parameters:

t - tensor

Returns:

transformed tensor

differentiate

public static Tensor differentiate(Tensor tensor,
                                   SimpleTensor var,
                                   int order)

Gives the multiple derivative of specified order of specified tensor with respect to specified simple tensor.

Parameters:

tensor - tensor to be differentiated

var - simple tensor

order - order of derivative

Returns:

derivative

Throws:

java.lang.IllegalArgumentException - if both order is not one and var is not scalar.

differentiate

public static Tensor differentiate(Tensor tensor,
                                   SimpleTensor... vars)

Gives the multiple derivative of specified tensor with respect to specified arguments.

Parameters:

tensor - tensor to be differentiated

vars - arguments

Returns:

derivative

Throws:

java.lang.IllegalArgumentException - if there is clash of indices

differentiate

public static Tensor differentiate(Tensor tensor,
                                   Transformation[] expandAndContract,
                                   SimpleTensor... vars)

Gives the multiple derivative of specified tensor with respect to specified arguments.

Parameters:

tensor - tensor to be differentiated

vars - arguments

expandAndContract - additional transformations to be applied after each step of differentiation

Returns:

derivative

Throws:

java.lang.IllegalArgumentException - if there is clash of indices