atleast
Apply a lower limit to the input; make it "at least" this value
Syntax
y = atleast ( x,limit )
y = x.atleast ( limit )
Inputs
| Argument | Type | Description | Unit |
|---|---|---|---|
x | scalar or vector | the input value or array | n/a |
limit | scalar or vector | the limit to impose | - |
Outputs / Return Value
y:yis the matrix, vector, or scalar of the same size asx
Notes
- For a matrix input, a row-wise operation is applied. That is, if limit is a scalar, it is applied to all rows; if it is a vector, each value in the limit vector is applied to each row until it is no longer available.
Examples
x=[2 9 3 4; 23 8 1 70; 201 400 623 300];
x.atleast(10) =
10 10 10 10
23 10 10 70
201 400 623 300<p>
x.atleast([3.5 10 250]) =
3.5 9 3.5 4
23 10 10 70
250 400 623 300<p>
See Also
Review Status
- Legacy parameter naming does not exactly match current engine metadata and should be reviewed manually.