Class CROperatorRemapParams

java.lang.Object
org.ddogleg.chainrule.ops.CROperatorRemapParams
All Implemented Interfaces:
CROperatorBackwardsJac<double[]>, CROperatorForward<double[]>
public class CROperatorRemapParams extends Object implements CROperatorBackwardsJac<double[]>
Remaps parameters from an input format into an output format. Does not change their values but can be configured to drop some elements. If there is no mapping to an element then it's value will be set to 0. Output vector size can be larger than the number of remapped elects to allow you to represent states. For example, if the consumer expected 12 states but you only need to popular 3 of them.

  • Constructor Details

    • CROperatorRemapParams

      public CROperatorRemapParams(int outputSize, int... mappings)
      Constructor which specifies how the remapping is done. A value of -1 in mappings means it should be skipped.
      Parameters:
      outputSize - Size of output vector
      mappings - How elements from the input vector map into the output vector

  • Method Details

    • setDefaultValues

      public CROperatorRemapParams setDefaultValues(double... values)
      Assigns the default value for the array

    • def

      public CROperatorRemapParams def(double... values)
      Shorthand for setDefaultValues(double...)

    • forward

      public void forward(CRArray<double[]> output)
      Description copied from interface: CROperatorForward
      Performs forward pass of the function. Must have already updated CROperatorForward.setInput(int, CRArray).
      Specified by:
      forward in interface CROperatorForward<double[]>
      Parameters:
      output - (Output) Output vector. Modified.

    • jacobian

      public void jacobian(CRMatrix<double[]> dout, List<CRMatrix<double[]>> jacobianInputs)
      Description copied from interface: CROperatorBackwardsJac

      Computes the Jacobian of all the inputs and parameters to this function.

      Mathematical explanation of how the partial derivatives are computed:

      @Out(..)/@x = [@f1(x,y)/@x @f1(x,y)/@y ; @f2(x,y)/@x ...  ] * @???/@f

      Where Out is the final output, 'f' is this function with two inputs (x,y). '@Out/@f' is dout.

      Specified by:
      jacobian in interface CROperatorBackwardsJac<double[]>
      Parameters:
      dout - (Input) Jacobian of output conditional on this function, computed from next layer.
      jacobianInputs - (Output) Storage for all the Jacobian inputs. All matrices must be pre-declared and included in the list. If a matrix is marked as invalid, then the jacobian is skipped for that input.

    • setInput

      public void setInput(int which, CRArray<double[]> input)
      Description copied from interface: CROperatorForward

      Specifies the value of an input's vector.

      The implementation can safely save the array input points at along with its offset. Neither the values at that offset nor the array itself will change until after CROperatorForward.forward(CRArray) or a derived function such as CROperatorBackwardsJac.jacobian(CRMatrix, List) has been called. The input reference itself cannot be saved: the caller is free to recycle the CRArray the moment the call returns, including pointing it at another offset.

      Specified by:
      setInput in interface CROperatorForward<double[]>
      Parameters:
      which - Which input
      input - The input's value. This reference can't be saved internally but the array and offset can be.

    • getInputSize

      public int getInputSize(int which)
      Description copied from interface: CROperatorForward
      Returns the specified input's vector size
      Specified by:
      getInputSize in interface CROperatorForward<double[]>

    • getInputCount

      public int getInputCount()
      Description copied from interface: CROperatorForward
      Number of inputs
      Specified by:
      getInputCount in interface CROperatorForward<double[]>

    • getOutputSize

      public int getOutputSize()
      Description copied from interface: CROperatorForward
      Returns the output vector's size
      Specified by:
      getOutputSize in interface CROperatorForward<double[]>

    • getArrayType

      public Class<double[]> getArrayType()
      Description copied from interface: CROperatorForward
      Primitive data type for the array
      Specified by:
      getArrayType in interface CROperatorForward<double[]>