Package com.singularsys.jep.functions

Class VSum

java.lang.Object
com.singularsys.jep.functions.PostfixMathCommand
com.singularsys.jep.functions.ArrayFunctionBase
com.singularsys.jep.functions.VSum
All Implemented Interfaces:
ZeroLengthBehaviourI, PostfixMathCommandI, Serializable
public class VSum extends ArrayFunctionBase
Summation function which expands the arguments. The VSum function will expand any arrays given as arguments so vsum([1,2],[3,4]) will be 10. This differs from the standard Sum function which does not expand them. The result of sum([1,2],[3,4]) in contrast would be [4,6].
Since:
3.4
See Also:

  • Field Details

    • add

      protected final Add add

  • Constructor Details

    • VSum

      public VSum()
      Default constructor. Sets the zero-length value to 0.0

    • VSum

      public VSum(ZeroLengthBehaviourI.ZeroLengthErrorBehaviour zeroLengthErrorBehaviour)
      Constructor with specified zero length error behaviour.

    • VSum

      public VSum(Object zeroLengthValue)
      Constructor with specified zero length value.

    • VSum

      public VSum(Add add, Object zeroLengthValue)
      Constructor with specified Add object and zero length value.

    • VSum

      public VSum(Add add, ZeroLengthBehaviourI.ZeroLengthErrorBehaviour zeroLengthErrorBehaviour)
      Constructor with specified Add object and zero length error behaviour.

  • Method Details

    • sum

      public Object sum(List<Object> vals) throws EvaluationException
      Returns the sum of a set of values. Depends on the Add classes to perform the calculation.
      Parameters:
      vals - Values to be averaged
      Returns:
      the sum of values
      Throws:
      EvaluationException - if the calculation cannot be performed

    • calc

      protected Object calc(List<Object> v) throws EvaluationException
      Description copied from class: ArrayFunctionBase
      Abstract method for performing the array calculation.
      Specified by:
      calc in class ArrayFunctionBase
      Parameters:
      v - The list to operate on. Note this is in reverse order of the arguments of the function.
      Returns:
      The result of the calculation.
      Throws:
      EvaluationException - if the calculation cannot be performed