stateVector.rename

Renames variables in a state vector


Syntax



Description

obj = obj.rename(-1, newNames)
obj = obj.rename(v, newNames)
obj = obj.rename(variableNames, newNames)

Renames the specified variables to the provided new names. If the first input is -1, selects all the variables in the state vector.


Input Arguments

v

logical vector [nVariables] | vector, linear indices | -1
The indices of the variables that should be renamed. If -1, selects all the variables in the state vector.

variableNames

string vector
The names of the variables that should be renamed.

Output Arguments

obj

scalar stateVector object
The stateVector object updated with the new variable names.