Libraries.Compute.MatrixTransform.SubtractScalar Documentation

This is a Matrix Transform class to subtract a value from every element of a Matrix. Attribute Returns A new matrix after the operation is performed.

Example Code

use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.SubtractScalar

class Main
    action Main
        Matrix matrix
        matrix:Fill(3, 3, 15.0)
        SubtractScalar scalar
        scalar:SetValue(matrix, 10.0)
        Matrix total = scalar:Transform(matrix)
        output total:ToText()
    end
end

Inherits from: Libraries.Language.Object, Libraries.Compute.MatrixTransform.MatrixTransform

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetValue()

This method gets the value that the transform function will apply. Attribute Parameter The value to apply in the transform.

Return

number:

Example

use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.SubtractScalar

class Main
    action Main
        Matrix matrix
        SubtractScalar scalar
        scalar:SetValue(matrix, 10.0)
        output scalar:GetValue()
    end
end

GetValueMatrix()

This method gets the matrix of values that the transform function will apply. Attribute Parameter The value to apply in the transform.

Return

Libraries.Compute.Matrix:

Example

use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.SubtractScalar

class Main
    action Main
        Matrix matrix
        matrix:Fill(3, 3, 5.0)
        SubtractScalar scalar
        scalar:SetValue(matrix)
        output scalar:GetValueMatrix():ToText()
    end
end

SetValue(Libraries.Compute.Matrix matrix)

This method sets the a matrix of values for the transform function to apply. Attribute Parameter The value to apply in the transform.

Parameters

Example

use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.SubtractScalar

class Main
    action Main
        Matrix matrix
        matrix:Fill(3, 3, 15.0)
        SubtractScalar scalar
        scalar:SetValue(matrix)
        Matrix total = scalar:Transform(matrix)
        output total:ToText()
    end
end

SetValue(Libraries.Compute.Matrix matrix, number value)

This method sets the value for the transform function to apply. Attribute Parameter The value to apply in the transform.

Parameters

Example

use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.SubtractScalar

class Main
    action Main
        Matrix matrix
        matrix:Fill(3, 3, 15.0)
        SubtractScalar scalar
        scalar:SetValue(matrix, 10.0)
        Matrix total = scalar:Transform(matrix)
        output total:ToText()
    end
end

Transform(Libraries.Compute.Matrix matrix)

This method applies the transform to the Matrix. Attribute Parameter The matrix to transform. Attribute Returns A new matrix after the operation is performed.

Parameters

Return

Libraries.Compute.Matrix:

Example

use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.SubtractScalar

class Main
    action Main
        Matrix matrix
        matrix:Fill(3, 3, 15.0)
        SubtractScalar scalar
        scalar:SetValue(matrix, 10.0)
        Matrix total = scalar:Transform(matrix)
        output total:ToText()
    end
end