These pages are auto-generated from self-documenting comments embedded in class files.
For more information on breve and steve, refer to the breve homepage.

Object : Vector

Class description:

Methods:

  • addScalar
  • addValues
  • copy
  • copyToBlueChannel
  • copyToGreenChannel
  • copyToRedChannel
  • getAbsoluteSum
  • getDimension
  • getValue
  • getVectorPointer
  • initWith
  • multiplyWithValues
  • printMatlabStyle
  • scale
  • setAllValues
  • setSize
  • setValue
  • setVectorPointer
  • subtractValues
  • transform
    addScalar( self, scalarValue )

    Adds the number scalarValue to each element in the vector.

    addValues( self, otherVector, scale )

    Adds this vector to otherVector leaving the result in otherVector. The matrices must be of the same size. The optional argument scale allows otherVector to be scaled before adding it to this vector.

    This method is hardware accelerated where supported.

    copy( self, otherVector )

    Copies the contents of otherVector to thisVector.

    This method is hardware accelerated where supported.

    copyToBlueChannel( self, theImage, scale )

    Copies the contents of this vector to the blue channel of theImage. The optional argument scale specifies how the vector elements should be scaled.

    This method, and it's counterparts copy-to-red-channel and copy-to-green-channel are far faster than looping manually through the vector values.

    copyToGreenChannel( self, theImage, scale )

    Copies the contents of this vector to the green channel of theImage. The optional argument scale specifies how the vector elements should be scaled.

    This method, and it's counterparts copy-to-blue-channel and copy-to-red-channel are far faster than looping manually through the vector values.

    copyToRedChannel( self, theImage, scale )

    Copies the contents of this vector to the red channel of theImage. The optional argument scale specifies how the vector elements should be scaled.

    This method, and it's counterparts copy-to-green-channel and copy-to-blue-channel are far faster than looping manually through the vector values.

    getAbsoluteSum( self )

    Returns the sum of the absolute values of all elements in this vector.

    This method is hardware accelerated where supported.

    getDimension( self )

    Returns the x size of this vector.

    getValue( self, x )

    Returns the vector value at position (x).

    getVectorPointer( self )

    initWith( self, newDim )

    Set the dimension of the vector to size. Clears contents.

    multiplyWithValues( self, otherVector )

    Multiplies each element in this vector with the corresponding element in otherVector. This is not regular vector multiplication; rather, it is a way to scale each element in otherVector.

    printMatlabStyle( self )

    Prints the vector in a style similar to MATLAB.

    scale( self, scaleValue )

    Scales all elements in the vector by scaleValue.

    This method is hardware accelerated where supported.

    setAllValues( self, value )

    Sets all of the values in the vector to value.

    setSize( self, newDim )

    Sets the size of this vector to the new dimension.

    setValue( self, value, x )

    Sets the vector value at position (x, y, z).

    setVectorPointer( self, newPointer, newDim )

    subtractValues( self, otherVector, scale )

    Subtracts this vector from this otherVector, leaving the result in otherVector. This method uses the same mechanism as add, but using a negative scale argument. The optional argument scale allows otherVector to be scaled before subtracting it from this vector.

    This method is hardware accelerated where supported.

    transform( self, transformation, result )

    Transforms this Vector with the Matrix2D matrix, storing the output in result.