## Libraries.Compute.MatrixTransform.MultiplyScalar Documentation

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

Example Code

``````use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.MultiplyScalar

class Main
action Main
Matrix matrix
matrix:Fill(3, 3, 5.0)
MultiplyScalar scalar
scalar:SetValue(matrix, 3.0)
Matrix total = scalar:Transform(matrix)
output total:ToText()
end
e``````

## Summary

### Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetValue()This method gets the value that the transform function will apply.
GetValueMatrix()This method gets the matrix of values that the transform function will apply.
SetValue(Libraries.Compute.Matrix matrix)This method sets the a matrix of values for the transform function to apply.
SetValue(Libraries.Compute.Matrix matrix, number value)This method sets the value for the transform function to apply.
Transform(Libraries.Compute.Matrix matrix)This method applies the transform to the Matrix.

## 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.

Example Code

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

#### Return

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

### Equals(Libraries.Language.Object object)

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

Example Code

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

#### Return

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

### GetHashCode()

This action gets the hash code for an object.

Example Code

``````Object o
integer hash = o:GetHashCode``````

#### Return

integer: The integer hash code of the object.

### GetValue()

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

Example Code

``````use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.MultiplyScalar

class Main
action Main
Matrix matrix
MultiplyScalar scalar
scalar:SetValue(matrix, 10.0)
output scalar:GetValue()
end
e``````

number:

### GetValueMatrix()

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

Example Code

``````use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.MultiplyScalar

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

### 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.

Example Code

``````use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.MultiplyScalar

class Main
action Main
Matrix matrix
matrix:Fill(3, 3, 5.0)
MultiplyScalar scalar
scalar:SetValue(matrix)
Matrix total = scalar:Transform(matrix)
output total:ToText()
end
e``````

### 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.

Example Code

``````use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.MultiplyScalar

class Main
action Main
Matrix matrix
matrix:Fill(3, 3, 5.0)
MultiplyScalar scalar
scalar:SetValue(matrix, 3.0)
Matrix total = scalar:Transform(matrix)
output total:ToText()
end
e``````

### 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.

Example Code

``````use Libraries.Compute.Matrix
use Libraries.Compute.MatrixTransform.MultiplyScalar

class Main
action Main
Matrix matrix
matrix:Fill(3, 3, 5.0)
MultiplyScalar scalar
scalar:SetValue(matrix, 3.0)
Matrix total = scalar:Transform(matrix)
output total:ToText()
end
e``````