Expressions are the basic building block of statements in Octave. An expression evaluates to a value, which you can print, test, store in a variable, pass to a function, or assign a new value to a variable with an assignment operator.
An expression can serve as a statement on its own. Most other kinds of statements contain one or more expressions which specify data to be operated on. As in other languages, expressions in Octave include variables, array references, constants, and function calls, as well as combinations of these with various operators.
An index expression allows you to reference or extract selected elements of a matrix or vector.
Indices may be scalars, vectors, ranges, or the special operator `:', which may be used to select entire rows or columns.
Vectors are indexed using a single expression. Matrices require two
indices unless the value of the builtin variable
do_fortran_indexing
is nonzero, in which case matrices may
also be indexed by a single expression.
do_fortran_indexing
is nonzero, Octave allows
you to select elements of a twodimensional matrix using a single index
by treating the matrix as a single vector created from the columns of
the matrix. The default value is 0.
Given the matrix
a = [1, 2; 3, 4]
all of the following expressions are equivalent
a (1, [1, 2]) a (1, 1:2) a (1, :)
and select the first row of the matrix.
A special form of indexing may be used to select elements of a matrix or vector. If the indices are vectors made up of only ones and zeros, the result is a new matrix whose elements correspond to the elements of the index vector that are equal to one. For example,
a = [1, 2; 3, 4]; a ([1, 0], :)
selects the first row of the matrix a
.
This operation can be useful for selecting elements of a matrix based on some condition, since the comparison operators return matrices of ones and zeros.
This special zeroone form of indexing leads to a conflict with the standard indexing operation. For example, should the following statements
a = [1, 2; 3, 4]; a ([1, 1], :)
return the original matrix, or the matrix formed by selecting the first
row twice? Although this conflict is not likely to arise very often in
practice, you may select the behavior you prefer by setting the builtin
variable prefer_zero_one_indexing
.
prefer_zero_one_indexing
is nonzero, Octave
will perform zeroone style indexing when there is a conflict with the
normal indexing rules. See section Index Expressions. For example, given a
matrix
a = [1, 2, 3, 4]
with prefer_zero_one_indexing
is set to nonzero, the
expression
a ([1, 1, 1, 1])
results in the matrix [ 1, 2, 3, 4 ]
. If the value of
prefer_zero_one_indexing
set to 0, the result would be
the matrix [ 1, 1, 1, 1 ]
.
In the first case, Octave is selecting each element corresponding to a `1' in the index vector. In the second, Octave is selecting the first element multiple times.
The default value for prefer_zero_one_indexing
is 0.
Finally, indexing a scalar with a vector of ones can be used to create a vector the same size as the index vector, with each element equal to the value of the original scalar. For example, the following statements
a = 13; a ([1, 1, 1, 1])
produce a vector whose four elements are all equal to 13.
Similarly, indexing a scalar with two vectors of ones can be used to create a matrix. For example the following statements
a = 13; a ([1, 1], [1, 1, 1])
create a 2 by 3 matrix with all elements equal to 13.
This is an obscure notation and should be avoided. It is better to
use the function ones
to generate a matrix of the appropriate
size whose elements are all one, and then to scale it to produce the
desired result. See section Special Utility Matrices.
prefer_column_vectors
is nonzero, operations like
for i = 1:10 a (i) = i; endfor
(for a
previously undefined) produce column vectors. Otherwise, row
vectors are preferred. The default value is 1.
If a variable is already defined to be a vector (a matrix with a single
row or column), the original orientation is respected, regardless of the
value of prefer_column_vectors
.
resize_on_range_error
is nonzero, expressions
like
for i = 1:10 a (i) = sqrt (i); endfor
(for a
previously undefined) result in the variable a
being resized to be just large enough to hold the new value. New
elements that have not been given a value are set to zero. If the value
of resize_on_range_error
is 0, an error message is printed and
control is returned to the top level. The default value is 1.
Note that it is quite inefficient to create a vector using a loop like the one shown in the example above. In this particular case, it would have been much more efficient to use the expression
a = sqrt (1:10);
thus avoiding the loop entirely. In cases where a loop is still
required, or a number of values must be combined to form a larger
matrix, it is generally much faster to set the size of the matrix first,
and then insert elements using indexing commands. For example, given a
matrix a
,
[nr, nc] = size (a); x = zeros (nr, n * nc); for i = 1:n x(:,(i1)*n+1:i*n) = a; endfor
is considerably faster than
x = a; for i = 1:n1 x = [x, a]; endfor
particularly for large matrices because Octave does not have to repeatedly resize the result.
A function is a name for a particular calculation. Because it has
a name, you can ask for it by name at any point in the program. For
example, the function sqrt
computes the square root of a number.
A fixed set of functions are builtin, which means they are
available in every Octave program. The sqrt
function is one of
these. In addition, you can define your own functions.
See section Functions and Script Files, for information about how to do this.
The way to use a function is with a function call expression, which consists of the function name followed by a list of arguments in parentheses. The arguments are expressions which give the raw materials for the calculation that the function will do. When there is more than one argument, they are separated by commas. If there are no arguments, you can omit the parentheses, but it is a good idea to include them anyway, to clearly indicate that a function call was intended. Here are some examples:
sqrt (x^2 + y^2) # One argument ones (n, m) # Two arguments rand () # No arguments
Each function expects a particular number of arguments. For example, the
sqrt
function must be called with a single argument, the number
to take the square root of:
sqrt (argument)
Some of the builtin functions take a variable number of arguments, depending on the particular usage, and their behavior is different depending on the number of arguments supplied.
Like every other expression, the function call has a value, which is
computed by the function based on the arguments you give it. In this
example, the value of sqrt (argument)
is the square root of
the argument. A function can also have side effects, such as assigning
the values of certain variables or doing input or output operations.
Unlike most languages, functions in Octave may return multiple values. For example, the following statement
[u, s, v] = svd (a)
computes the singular value decomposition of the matrix a
and
assigns the three result matrices to u
, s
, and v
.
The left side of a multiple assignment expression is itself a list of expressions, and is allowed to be a list of variable names or index expressions. See also section Index Expressions, and section Assignment Expressions.
In Octave, unlike Fortran, function arguments are passed by value, which means that each argument in a function call is evaluated and assigned to a temporary location in memory before being passed to the function. There is currently no way to specify that a function parameter should be passed by reference instead of by value. This means that it is impossible to directly alter the value of function parameter in the calling function. It can only change the local copy within the function body. For example, the function
function f (x, n) while (n > 0) disp (x); endwhile endfunction
displays the value of the first argument n times. In this function, the variable n is used as a temporary variable without having to worry that its value might also change in the calling function. Call by value is also useful because it is always possible to pass constants for any function parameter without first having to determine that the function will not attempt to modify the parameter.
The caller may use a variable as the expression for the argument, but the called function does not know this: it only knows what value the argument had. For example, given a function called as
foo = "bar"; fcn (foo)
you should not think of the argument as being "the variable
foo
." Instead, think of the argument as the string value,
"bar"
.
Even though Octave uses passbyvalue semantics for function arguments, values are not copied unnecessarily. For example,
x = rand (1000); f (x);
does not actually force two 1000 by 1000 element matrices to exist
unless the function f
modifies the value of its
argument. Then Octave must create a copy to avoid changing the
value outside the scope of the function f
, or attempting (and
probably failing!) to modify the value of a constant or the value of a
temporary result.
With some restrictions(2), recursive function calls are allowed. A recursive function is one which calls itself, either directly or indirectly. For example, here is an inefficient(3) way to compute the factorial of a given integer:
function retval = fact (n) if (n > 0) retval = n * fact (n1); else retval = 1; endif endfunction
This function is recursive because it calls itself directly. It eventually terminates because each time it calls itself, it uses an argument that is one less than was used for the previous call. Once the argument is no longer greater than zero, it does not call itself, and the recursion ends.
The builtin variable max_recursion_depth
specifies a limit to
the recursion depth and prevents Octave from recursing infinitely.
The default value is 256.
The following arithmetic operators are available, and work on scalars and matrices.
x + y
x .+ y
+
.
x  y
x . y

.
x * y
x .* y
x / y
(inverse (y') * x')'but it is computed without forming the inverse of y'. If the system is not square, or if the coefficient matrix is singular, a minimum norm solution is computed.
x ./ y
x \ y
inverse (x) * ybut it is computed without forming the inverse of x. If the system is not square, or if the coefficient matrix is singular, a minimum norm solution is computed.
x .\ y
x ^ y
x ** y
x .^ y
x .** y
x
+x
x'
conj (x.')
x.'
Note that because Octave's element by element operators begin with a `.', there is a possible ambiguity for statements like
1./m
because the period could be interpreted either as part of the constant or as part of the operator. To resolve this conflict, Octave treats the expression as if you had typed
(1) ./ m
and not
(1.) / m
Although this is inconsistent with the normal behavior of Octave's lexer, which usually prefers to break the input into tokens by preferring the longest possible match at any given point, it is more useful in this case.
warn_divide_by_zero
is nonzero, a warning
is issued when Octave encounters a division by zero. If the value is
0, the warning is omitted. The default value is 1.
Comparison operators compare numeric values for relationships such as equality. They are written using relational operators.
All of Octave's comparison operators return a value of 1 if the comparison is true, or 0 if it is false. For matrix values, they all work on an elementbyelement basis. For example,
[1, 2; 3, 4] == [1, 3; 2, 4] => 1 0 0 1
If one operand is a scalar and the other is a matrix, the scalar is compared to each element of the matrix in turn, and the result is the same size as the matrix.
x < y
x <= y
x == y
x >= y
x > y
x != y
x ~= y
x <> y
String comparisons may also be performed with the strcmp
function, not with the comparison operators listed above.
See section Strings.
An elementbyelement boolean expression is a combination of comparison expressions using the boolean operators "or" (`'), "and" (`&'), and "not" (`!'), along with parentheses to control nesting. The truth of the boolean expression is computed by combining the truth values of the corresponding elements of the component expressions. A value is considered to be false if it is zero, and true otherwise.
Elementbyelement boolean expressions can be used wherever comparison
expressions can be used. They can be used in if
and while
statements. However, if a matrix value used as the condition in an
if
or while
statement is only true if all of its
elements are nonzero.
Like comparison operations, each element of an elementbyelement boolean expression also has a numeric value (1 if true, 0 if false) that comes into play if the result of the boolean expression is stored in a variable, or used in arithmetic.
Here are descriptions of the three elementbyelement boolean operators.
boolean1 & boolean2
boolean1  boolean2
! boolean
~ boolean
For matrix operands, these operators work on an elementbyelement basis. For example, the expression
[1, 0; 0, 1] & [1, 0; 2, 3]
returns a two by two identity matrix.
For the binary operators, the dimensions of the operands must conform if both are matrices. If one of the operands is a scalar and the other a matrix, the operator is applied to the scalar and each element of the matrix.
For the binary elementbyelement boolean operators, both subexpressions boolean1 and boolean2 are evaluated before computing the result. This can make a difference when the expressions have side effects. For example, in the expression
a & b++
the value of the variable b is incremented even if the variable a is zero.
This behavior is necessary for the boolean operators to work as described for matrixvalued operands.
Combined with the implicit conversion to scalar values in if
and
while
conditions, Octave's elementbyelement boolean operators
are often sufficient for performing most logical operations. However,
it is sometimes desirable to stop evaluating a boolean expression as
soon as the overall truth value can be determined. Octave's
shortcircuit boolean operators work this way.
boolean1 && boolean2
all (all (boolean1))
.
If it is false, the result of the overall expression is 0. If it is
true, the expression boolean2 is evaluated and converted to a
scalar using the equivalent of the operation all (all
(boolean1))
. If it is true, the result of the overall expression
is 1. Otherwise, the result of the overall expression is 0.
boolean1  boolean2
all (all (boolean1))
.
If it is true, the result of the overall expression is 1. If it is
false, the expression boolean2 is evaluated and converted to a
scalar using the equivalent of the operation all (all
(boolean1))
. If it is true, the result of the overall expression
is 1. Otherwise, the result of the overall expression is 0.
The fact that both operands may not be evaluated before determining the overall truth value of the expression can be important. For example, in the expression
a && b++
the value of the variable b is only incremented if the variable a is nonzero.
This can be used to write somewhat more concise code. For example, it is possible write
function f (a, b, c) if (nargin > 2 && isstr (c)) ...
instead of having to use two if
statements to avoid attempting to
evaluate an argument that doesn't exist. For example, without the
shortcircuit feature, it would be necessary to write
function f (a, b, c) if (nargin > 2) if (isstr (c)) ...
Writing
function f (a, b, c) if (nargin > 2 & isstr (c)) ...
would result in an error if f
were called with one or two
arguments because Octave would be forced to try to evaluate both of the
operands for the operator `&'.
An assignment is an expression that stores a new value into a
variable. For example, the following expression assigns the value 1 to
the variable z
:
z = 1
After this expression is executed, the variable z
has the value 1.
Whatever old value z
had before the assignment is forgotten.
The `=' sign is called an assignment operator.
Assignments can store string values also. For example, the following
expression would store the value "this food is good"
in the
variable message
:
thing = "food" predicate = "good" message = [ "this " , thing , " is " , predicate ]
(This also illustrates concatenation of strings.)
Most operators (addition, concatenation, and so on) have no effect except to compute a value. If you ignore the value, you might as well not use the operator. An assignment operator is different. It does produce a value, but even if you ignore the value, the assignment still makes itself felt through the alteration of the variable. We call this a side effect.
The lefthand operand of an assignment need not be a variable (see section Variables). It can also be an element of a matrix (see section Index Expressions) or a list of return values (see section Calling Functions). These are all called lvalues, which means they can appear on the lefthand side of an assignment operator. The righthand operand may be any expression. It produces the new value which the assignment stores in the specified variable, matrix element, or list of return values.
It is important to note that variables do not have permanent types.
The type of a variable is simply the type of whatever value it happens
to hold at the moment. In the following program fragment, the variable
foo
has a numeric value at first, and a string value later on:
octave:13> foo = 1 foo = 1 octave:13> foo = "bar" foo = bar
When the second assignment gives foo
a string value, the fact that
it previously had a numeric value is forgotten.
Assignment of a scalar to an indexed matrix sets all of the elements
that are referenced by the indices to the scalar value. For example, if
a
is a matrix with at least two columns,
a(:, 2) = 5
sets all the elements in the second column of a
to 5.
Assigning an empty matrix `[]' works in most cases to allow you to delete rows or columns of matrices and vectors. See section Empty Matrices. For example, given a 4 by 5 matrix A, the assignment
A (3, :) = []
deletes the third row of A, and the assignment
A (:, 1:2:5) = []
deletes the first, third, and fifth columns.
An assignment is an expression, so it has a value. Thus, z = 1
as an expression has the value 1. One consequence of this is that you
can write multiple assignments together:
x = y = z = 0
stores the value 0 in all three variables. It does this because the
value of z = 0
, which is 0, is stored into y
, and then
the value of y = z = 0
, which is 0, is stored into x
.
This is also true of assignments to lists of values, so the following is a valid expression
[a, b, c] = [u, s, v] = svd (a)
that is exactly equivalent to
[u, s, v] = svd (a) a = u b = s c = v
In expressions like this, the number of values in each part of the expression need not match. For example, the expression
[a, b, c, d] = [u, s, v] = svd (a)
is equivalent to the expression above, except that the value of the variable `d' is left unchanged, and the expression
[a, b] = [u, s, v] = svd (a)
is equivalent to
[u, s, v] = svd (a) a = u b = s
You can use an assignment anywhere an expression is called for. For
example, it is valid to write x != (y = 1)
to set y
to 1
and then test whether x
equals 1. But this style tends to make
programs hard to read. Except in a oneshot program, you should rewrite
it to get rid of such nesting of assignments. This is never very hard.
Increment operators increase or decrease the value of a variable by 1. The operator to increment a variable is written as `++'. It may be used to increment a variable either before or after taking its value.
For example, to preincrement the variable x, you would write
++x
. This would add one to x and then return the new
value of x as the result of the expression. It is exactly the
same as the expression x = x + 1
.
To postincrement a variable x, you would write x++
.
This adds one to the variable x, but returns the value that
x had prior to incrementing it. For example, if x is equal
to 2, the result of the expression x++
is 2, and the new
value of x is 3.
For matrix and vector arguments, the increment and decrement operators work on each element of the operand.
Here is a list of all the increment and decrement expressions.
++x
x = x + 1
.
x
x = x  1
.
x++
x
It is not currently possible to increment index expressions. For
example, you might expect that the expression v(4)++
would
increment the fourth element of the vector v, but instead it
results in a parse error. This problem may be fixed in a future
release of Octave.
Operator precedence determines how operators are grouped, when
different operators appear close by in one expression. For example,
`*' has higher precedence than `+'. Thus, the expression
a + b * c
means to multiply b
and c
, and then add
a
to the product (i.e., a + (b * c)
).
You can overrule the precedence of the operators by using parentheses. You can think of the precedence rules as saying where the parentheses are assumed if you do not write parentheses yourself. In fact, it is wise to use parentheses whenever you have an unusual combination of operators, because other people who read the program may not remember what the precedence is in this case. You might forget as well, and then you too could make a mistake. Explicit parentheses will help prevent any such mistake.
When operators of equal precedence are used together, the leftmost
operator groups first, except for the assignment and exponentiation
operators, which group in the opposite order. Thus, the expression
a  b + c
groups as (a  b) + c
, but the expression
a = b = c
groups as a = (b = c)
.
The precedence of prefix unary operators is important when another
operator follows the operand. For example, x^2
means
(x^2)
, because `' has lower precedence than `^'.
Here is a table of the operators in Octave, in order of increasing precedence.
statement separators
assignment
logical "or" and "and"
elementwise "or" and "and"
relational
colon
add, subtract
multiply, divide
transpose
unary plus, minus, increment, decrement, and "not"
exponentiation
Go to the first, previous, next, last section, table of contents.