Using Octave: Difference between revisions

From Octave
Jump to navigation Jump to search
(Code examples in wiki markup)
(5 intermediate revisions by one other user not shown)
Line 27: Line 27:


<syntaxhighlight lang="octave">t = 99 + 1  # prints 't = 100'</syntaxhighlight>
<syntaxhighlight lang="octave">t = 99 + 1  # prints 't = 100'</syntaxhighlight>
<syntaxhighlight>t =  100</syntaxhighlight>
<syntaxhighlight lang="text">t =  100</syntaxhighlight>


<syntaxhighlight lang="octave">t = 99 + 1; # nothing is printed
<syntaxhighlight lang="octave">t = 99 + 1; # nothing is printed
disp(t);</syntaxhighlight>
disp(t);</syntaxhighlight>
<syntaxhighlight> 100</syntaxhighlight>
<syntaxhighlight lang="text"> 100</syntaxhighlight>


= Elementary math =
= Elementary math =
Line 41: Line 41:
<syntaxhighlight lang="octave">x = 3/4 * pi;
<syntaxhighlight lang="octave">x = 3/4 * pi;
y = sin (x)</syntaxhighlight>
y = sin (x)</syntaxhighlight>
<syntaxhighlight>y =  0.70711</syntaxhighlight>
<syntaxhighlight lang="text">y =  0.70711</syntaxhighlight>




Line 53: Line 53:
[https://www.gnu.org/software/octave/doc/interpreter/Linear-Algebra.html about matrices].
[https://www.gnu.org/software/octave/doc/interpreter/Linear-Algebra.html about matrices].
<syntaxhighlight lang="octave">rowVec = [8 6 4]</syntaxhighlight>
<syntaxhighlight lang="octave">rowVec = [8 6 4]</syntaxhighlight>
<syntaxhighlight>rowVec =
<syntaxhighlight lang="text">rowVec =
   8  6  4
   8  6  4
</syntaxhighlight>
</syntaxhighlight>


<syntaxhighlight lang="octave">columnVec = [8; 6; 4]</syntaxhighlight>
<syntaxhighlight lang="octave">columnVec = [8; 6; 4]</syntaxhighlight>
<syntaxhighlight>columnVec =
<syntaxhighlight lang="text">columnVec =
   8
   8
   6
   6
Line 65: Line 65:


<syntaxhighlight lang="octave">mat = [8 6 4; 2 0 -2]</syntaxhighlight>
<syntaxhighlight lang="octave">mat = [8 6 4; 2 0 -2]</syntaxhighlight>
<syntaxhighlight>mat =
<syntaxhighlight lang="text">mat =
   8  6  4
   8  6  4
   2  0  -2
   2  0  -2
Line 71: Line 71:


<syntaxhighlight lang="octave">size(mat)</syntaxhighlight>
<syntaxhighlight lang="octave">size(mat)</syntaxhighlight>
<syntaxhighlight>ans =
<syntaxhighlight lang="text">ans =
   2  3
   2  3
</syntaxhighlight>
</syntaxhighlight>


<syntaxhighlight lang="octave">length(rowVec)</syntaxhighlight>
<syntaxhighlight lang="octave">length(rowVec)</syntaxhighlight>
<syntaxhighlight>ans =  3</syntaxhighlight>
<syntaxhighlight lang="text">ans =  3</syntaxhighlight>




Line 87: Line 87:


<syntaxhighlight lang="octave">columnVec * rowVec</syntaxhighlight>
<syntaxhighlight lang="octave">columnVec * rowVec</syntaxhighlight>
<syntaxhighlight>ans =
<syntaxhighlight lang="text">ans =
   64  48  32
   64  48  32
   48  36  24
   48  36  24
Line 94: Line 94:


<syntaxhighlight lang="octave">rowVec * columnVec</syntaxhighlight>
<syntaxhighlight lang="octave">rowVec * columnVec</syntaxhighlight>
<syntaxhighlight>ans =  116</syntaxhighlight>
<syntaxhighlight lang="text">ans =  116</syntaxhighlight>


<syntaxhighlight lang="octave">columnVec'</pre>
<syntaxhighlight lang="octave">columnVec'</syntaxhighlight>
<syntaxhighlight>ans =
<syntaxhighlight lang="text">ans =
   8  6  4
   8  6  4
</syntaxhighlight>
</syntaxhighlight>


= Accessing Elements =
= Accessing Elements =
Line 110: Line 108:


<syntaxhighlight lang="octave">mat(2,3)</syntaxhighlight>
<syntaxhighlight lang="octave">mat(2,3)</syntaxhighlight>
<syntaxhighlight>ans = -2</syntaxhighlight>
<syntaxhighlight lang="text">ans = -2</syntaxhighlight>






= Control flow wih loops =
= Control flow with loops =


Octave supports <code>for</code> and <code>while</code> loops, as well as other control flow
Octave supports <code>for</code> and <code>while</code> loops, as well as other control flow
Line 128: Line 126:
k = 1;
k = 1;
step = 2;
step = 2;
while (k <= (100-step))
while (k <= 100)
   y(i) = k^2;
   y(k) = k^2;
   k = k + step;
   k = k + step;
endwhile</syntaxhighlight>
endwhile</syntaxhighlight>


= Vectorization =
= Vectorization =
Line 158: Line 154:
[https://www.gnu.org/software/octave/doc/interpreter/Two_002dDimensional-Plots.html about plotting].
[https://www.gnu.org/software/octave/doc/interpreter/Two_002dDimensional-Plots.html about plotting].


<syntaxhighlight lang="octave">plot (i/10, w);
<syntaxhighlight lang="octave">plot (i / 10, w);
title ('w = sin(i/10)');
title ('w = sin (i / 10)');
xlabel ('i ÷ 10');
xlabel ('i / 10');
ylabel ('w');</syntaxhighlight>
ylabel ('w');</syntaxhighlight>


<img src="octave_basics-1.png" alt="octave_basics-1.png">
[[File:Using octave-1.png|thumb|center]]
 
 


= Strings =
= Strings =
Line 178: Line 172:
[firstString, secondString] # concatenate both strings
[firstString, secondString] # concatenate both strings
</syntaxhighlight>
</syntaxhighlight>
<syntaxhighlight>ans = hello world!</syntaxhighlight>
<syntaxhighlight lang="text">ans = hello world!</syntaxhighlight>


<syntaxhighlight lang="octave">fprintf ("%s %.10f \n", "The number is:", 10)</syntaxhighlight>
<syntaxhighlight lang="octave">fprintf ("%s %.10f \n", "The number is:", 10)</syntaxhighlight>
<syntaxhighlight>The number is: 10.0000000000</syntaxhighlight>
<syntaxhighlight lang="text">The number is: 10.0000000000</syntaxhighlight>




Line 209: Line 203:
endfor</syntaxhighlight>
endfor</syntaxhighlight>


<syntaxhighlight>i=1:   
<syntaxhighlight lang="text">i=1:   
i=2:   
i=2:   
i=3: Fizz  
i=3: Fizz  

Revision as of 08:27, 21 April 2017

First, follow the installation guide to install GNU Octave on your system. Then, launch the interactive prompt by typing octave in a terminal or by clicking the icon in the programs menu. For further guidance, see the manual page on Running Octave.


Variable Assignment

Assign values to variables with = (Note: assignment is pass-by-value). Read more about variables.

a = 1;

Comments

# or % start a comment line, that continues to the end of the line. Read more about comments.

Command evaluation

The output of every command is printed to the console unless terminated with a semicolon ;. The disp command can be used to print output anywhere. Use exit or quit to quit the console. Read more about command evaluation.

t = 99 + 1  # prints 't = 100'
t =  100
t = 99 + 1; # nothing is printed
disp(t);
 100

Elementary math

Many mathematical operators are available in addition to the standard arithmetic. Operations are floating-point. Read more about elementary math.

x = 3/4 * pi;
y = sin (x)
y =  0.70711



Matrices

Arrays in Octave are called matrices. One-dimensional matrices are referred to as vectors. Use a space or a comma , to separate elements in a row and semicolon ; to start a new row. Read more about matrices.

rowVec = [8 6 4]
rowVec =
   8   6   4
columnVec = [8; 6; 4]
columnVec =
   8
   6
   4
mat = [8 6 4; 2 0 -2]
mat =
   8   6   4
   2   0  -2
size(mat)
ans =
   2   3
length(rowVec)
ans =  3


Linear Algebra

Many common linear algebra operations are simple to program using Octave’s matrix syntax. Read more about linear algebra.

columnVec * rowVec
ans =
   64   48   32
   48   36   24
   32   24   16
rowVec * columnVec
ans =  116
columnVec'
ans =
   8   6   4

Accessing Elements

Octave is 1-indexed. Matrix elements are accessed as matrix(rowNum, columnNum). Read more about accessing elements.

mat(2,3)
ans = -2


Control flow with loops

Octave supports for and while loops, as well as other control flow structures. Read more about control flow.

x = zeros (50,1);
for i = 1:2:100 # iterate from 1 to 100 with step size 2
  x(i) = i^2;
endfor

y = zeros (50,1);
k = 1;
step = 2;
while (k <= 100)
  y(k) = k^2;
  k = k + step;
endwhile

Vectorization

For-loops can often be replaced or simplified using vector syntax. The operators *, /, and ^ all support element-wise operations writing a dot . before the operators. Many other functions operate element-wise by default (sin, +, -, etc.). Read more about vectorization.

i = 1:2:100;      # create an array with 50-elements
x = i.^2;         # each element is squared
y = x + 9;        # add 9 to each element
z = y./i;         # divide each element in y by the corresponding value in i
w = sin (i / 10); # take the sine of each element divided by 10


Plotting

The function plot can be called with vector arguments to create 2D line and scatter plots. Read more about plotting.

plot (i / 10, w);
title ('w = sin (i / 10)');
xlabel ('i / 10');
ylabel ('w');
Using octave-1.png

Strings

Strings are simply arrays of characters. Strings can be composed using C-style formatting with sprintf or fprintf. Read more about strings.

firstString = "hello world";
secondString = "!";
[firstString, secondString] # concatenate both strings
ans = hello world!
fprintf ("%s %.10f \n", "The number is:", 10)
The number is: 10.0000000000


If-else

Conditional statements can be used to create branching logic in your code. Read more in the manual.

# Print 'Foo'      if divisible by 7,
#       'Fizz'     if divisible by 3,
#       'Buzz'     if divisible by 5,
#       'FizzBuzz' if divisible by 3 and 5
for i = 1:1:20
  outputString = "";
  if (rem (i, 3) == 0)  # rem is the remainder function
    outputString = [outputString, "Fizz"];
  endif
  if (rem (i, 5) == 0)
    outputString = [outputString, "Buzz"];
  elseif (rem(i,7) == 0)
    outputString = "Foo";
  else
    outputString = outputString;
  endif
  fprintf("i=%g: %s \n", i, outputString);
endfor
i=1:  
i=2:  
i=3: Fizz 
i=4:  
i=5: Buzz 
i=6: Fizz 
i=7: Foo 
i=8:  
i=9: Fizz 
i=10: Buzz 
i=11:  
i=12: Fizz 
i=13:  
i=14: Foo 
i=15: FizzBuzz 
i=16:  
i=17:  
i=18: Fizz 
i=19:  
i=20: Buzz


Getting Help

The help and doc commands can be invoked at the Octave prompt to print documentation for any function.

help plot
doc plot


Octave forge packages

Community-developed packages can be added from the Octave Forge website to extend the functionality of Octave’s core library. (Matlab users: Forge packages act similarly to Matlab’s toolboxes.) The pkg command is used to manage these packages. For example, to use the image processing library from the Forge, use:

pkg install -forge image # install package
pkg load image           # load new functions into workspace

Read more about packages.