Method ao/mod
MOD overloads the modulus function for analysis objects.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DESCRIPTION: MOD overloads the modulus operator for analysis objects.
CALL: out = mod(a, val)
out = mod(a, plist('axis', 'y', 'value', val))
INPUTS: a - Single or vector of analysis objects
val - Numeric value
Parameters Description
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
| Method Details |
|
| Access |
public |
| Defining Class |
ao |
| Sealed |
0 |
| Static |
0 |
Parameter Description
| Sets for this method … |
| 1D |
| 2D |
| 3D |
1D |
| no description |
| Key |
Default Value |
Options |
Description |
| mod |
| AXIS |
'y' |
none |
The axis on which to apply the method. |
| VALUE |
[] |
none |
Value for the modulus operation. |
Example |
| plist('AXIS', 'y', 'VALUE', [[]]) |
back to top
2D |
| no description |
| Key |
Default Value |
Options |
Description |
| mod |
| AXIS |
'y' |
|
The axis on which to apply the method. |
| VALUE |
[] |
none |
Value for the modulus operation. |
Example |
| plist('AXIS', 'y', 'VALUE', [[]]) |
back to top
3D |
| no description |
| Key |
Default Value |
Options |
Description |
| mod |
| AXIS |
'z' |
|
The axis on which to apply the method. |
| VALUE |
[] |
none |
Value for the modulus operation. |
Example |
| plist('AXIS', 'z', 'VALUE', [[]]) |
back to top
| Some information of the method ao/mod are listed below: |
| Class name |
ao |
| Method name |
mod |
| Category |
Arithmetic Operator |
| Package name |
ltpda |
| VCS Version |
967b0eec0dece803a81af8ef54ad2f8c784b20b2 |
| Min input args |
1 |
| Max input args |
-1 |
| Min output args |
1 |
| Max output args |
-1 |
| Can be used as modifier |
1 |
| Supported numeric types |
{'double'} |
|
Method: ao/minus |
|
Method: ao/mpower |
 |
©LTP Team