935
edits
Changes
Jump to navigation
Jump to search
Created page with "__NOTOC__ var.'''storeAt''' is a function that is part of the Var library.<br /> Stores a numeric value into an element of a math list or matrix with the give..."
__NOTOC__
var.'''storeAt''' is a function that is part of the [[:Category:var|Var]] library.<br />
Stores a numeric value into an element of a math list or matrix with the given name.
The value must be numeric. Any other type will raise an error. <br />
New values can be appended to a list by storing to one column past the end of the list.<br />
This function is particularly useful as an optimization when adding new values to a list during a simulation.<br />
Returns nil on success or "cannot store" if the value cannot be stored at the given index.
{{Since|3.2}}
== Syntax ==
var.'''storeAt'''(name, numericValue, column [,row])
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <u><center>name</center></u> || string || Name of the variable to grab from
|-
| <u><center>numericValue</center></u> || number || The numeric value to be stored.
|-
| <u><center>column</center></u> || number || 1-based column number of the matrix or list.
|-
| <u><center>row</center></u> || number || ''(Optional)'' 1-based row number. ''row'' is only required when recalling a value from a matrix.
|-
|}
== Example ==
<syntaxhighlight>var.store("mat", {{1,2}, {3,4}}) -- create matrix mat in the symbol table
var.storeAt("mat", 13.3, 1, 1) -- puts the number 13.1 into the field 1,1 of the matrix
val = var.recallAt("mat", 1, 1) -- grab it back in lua</syntaxhighlight>
== Good to know ==
Routines [[var.recallAt]] and [[var.storeAt]] will work with matrices but only if they are created by some other means ([[var.store]]) :
== See also ==
*[[var.recallAt]]
*[[var.makeNumericList]]
<br />
[[Category:var]]
var.'''storeAt''' is a function that is part of the [[:Category:var|Var]] library.<br />
Stores a numeric value into an element of a math list or matrix with the given name.
The value must be numeric. Any other type will raise an error. <br />
New values can be appended to a list by storing to one column past the end of the list.<br />
This function is particularly useful as an optimization when adding new values to a list during a simulation.<br />
Returns nil on success or "cannot store" if the value cannot be stored at the given index.
{{Since|3.2}}
== Syntax ==
var.'''storeAt'''(name, numericValue, column [,row])
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <u><center>name</center></u> || string || Name of the variable to grab from
|-
| <u><center>numericValue</center></u> || number || The numeric value to be stored.
|-
| <u><center>column</center></u> || number || 1-based column number of the matrix or list.
|-
| <u><center>row</center></u> || number || ''(Optional)'' 1-based row number. ''row'' is only required when recalling a value from a matrix.
|-
|}
== Example ==
<syntaxhighlight>var.store("mat", {{1,2}, {3,4}}) -- create matrix mat in the symbol table
var.storeAt("mat", 13.3, 1, 1) -- puts the number 13.1 into the field 1,1 of the matrix
val = var.recallAt("mat", 1, 1) -- grab it back in lua</syntaxhighlight>
== Good to know ==
Routines [[var.recallAt]] and [[var.storeAt]] will work with matrices but only if they are created by some other means ([[var.store]]) :
== See also ==
*[[var.recallAt]]
*[[var.makeNumericList]]
<br />
[[Category:var]]
