org.lsmp.djep.vectorJep.function

Class Length

java.lang.Object

org.nfunk.jep.function.PostfixMathCommand

org.lsmp.djep.vectorJep.function.Length

All Implemented Interfaces:

UnaryOperatorI, PostfixMathCommandI

public class Length
extends PostfixMathCommand
implements UnaryOperatorI

Returns the length of a vector. If the argument is a scaler, matrix or tensor returns total number of elements.

 len(5) -> 1
 len([1,2,3]) -> 3
 len([[1,2],[3,4],[5,6]]) -> 6
 

Author:

Rich Morris Created on 13-Feb-2005

Field Summary

Fields inherited from class org.nfunk.jep.function.PostfixMathCommand

curNumberOfParameters, numberOfParameters

Constructor Summary

Constructors

Constructor and Description
Length()

Method Summary

Modifier and Type	Method and Description
Dimensions	calcDim(Dimensions ldim) Find the dimensions of this operator when applied to arguments with given dimensions.
MatrixValueI	calcValue(MatrixValueI res, MatrixValueI lhs) Calculates the value of this operator for given input with results stored in res.
void	run(Stack aStack) Throws an exception because this method should never be called under normal circumstances.

Methods inherited from class org.nfunk.jep.function.PostfixMathCommand

checkNumberOfParameters, checkStack, getNumberOfParameters, setCurNumberOfParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nfunk.jep.function.PostfixMathCommandI

checkNumberOfParameters, getNumberOfParameters, setCurNumberOfParameters

Constructor Detail

Length

public Length()

Method Detail

calcDim

public Dimensions calcDim(Dimensions ldim)

Description copied from interface: UnaryOperatorI

Find the dimensions of this operator when applied to arguments with given dimensions.

Specified by:

calcDim in interface UnaryOperatorI

calcValue

public MatrixValueI calcValue(MatrixValueI res,
                              MatrixValueI lhs)
                       throws ParseException

Description copied from interface: UnaryOperatorI

Calculates the value of this operator for given input with results stored in res. res is returned. Using this method is slightly faster than the standard run method as it eliminates the construction of tempoary objects.

Specified by:

calcValue in interface UnaryOperatorI

Throws:

ParseException

run

public void run(Stack aStack)
         throws ParseException

Description copied from class: PostfixMathCommand

Throws an exception because this method should never be called under normal circumstances. Each function should use it's own run() method for evaluating the function. This includes popping off the parameters from the stack, and pushing the result back on the stack.

Specified by:

run in interface PostfixMathCommandI

Overrides:

run in class PostfixMathCommand

Throws:

ParseException