Difference between revisions of "Python/Program Flow and Logicals"

From ECLR
Jump to: navigation, search
(Preliminaries)
Line 13: Line 13:
 
   ...
 
   ...
 
</source>
 
</source>
where the code in lines <source lang="python" enclose=none>statement1</source>, <source lang="python" enclose=none>statement2</source>, <source lang="python" enclose=none>...</source> is executed only if <source lang="python" enclose=none>condition</source> is <source lang="python" enclose=none>True</source>. Sharp sighted readers might spot another difference to MATLAB, in Python there is no need to add a semicolon at the end of a line to suppress output.
+
where the code in lines <source lang="python" enclose=none>statement1</source>, <source lang="python" enclose=none>statement2</source>, <source lang="python" enclose=none>...</source> is executed only if <source lang="python" enclose=none>condition</source> is <source lang="python" enclose=none>True</source>. Sharp sighted readers might spot another difference to MATLAB, in general in Python there is no need to add a semicolon at the end of a line to suppress output, since Python produces no output for lines involving assignment (i.e. with the  <source lang="python" enclose=none>=</source> sign).
  
 
The boolean <source lang="python" enclose=none>condition</source> can be built up using relational and logical operators. Relational operators in Python are similar to those in MATLAB, e.g. <source lang="python" enclose=none>==</source> tests for '''equality''', <source lang="python" enclose=none>></source> and <source lang="python" enclose=none>>=</source> test for '''greater than''' and '''greater than or equal to''' respectively. The main difference is that<source lang="python" enclose=none>!=</source> tests for '''inequality''' in Python, compared to <source enclose=none>~=</source> in MATLAB. Relational operators return boolean values of either <source lang="python" enclose=none>True</source> or <source lang="python" enclose=none>False</source>.
 
The boolean <source lang="python" enclose=none>condition</source> can be built up using relational and logical operators. Relational operators in Python are similar to those in MATLAB, e.g. <source lang="python" enclose=none>==</source> tests for '''equality''', <source lang="python" enclose=none>></source> and <source lang="python" enclose=none>>=</source> test for '''greater than''' and '''greater than or equal to''' respectively. The main difference is that<source lang="python" enclose=none>!=</source> tests for '''inequality''' in Python, compared to <source enclose=none>~=</source> in MATLAB. Relational operators return boolean values of either <source lang="python" enclose=none>True</source> or <source lang="python" enclose=none>False</source>.
Line 55: Line 55:
 
Like MATLAB, Python has while and for loops. Unconditional for loops iterate over a '''list''' of values
 
Like MATLAB, Python has while and for loops. Unconditional for loops iterate over a '''list''' of values
  
<source lang="python">for CounterVariable in ListOfValues:
+
<source lang="python">for LoopVariable in ListOfValues:
 
   statement1
 
   statement1
 
   statement2
 
   statement2
 
   ...
 
   ...
 
</source>
 
</source>
and repeat for as many times as there are elements in the <source lang="python" enclose=none>ListOfValues</source>, each time assigning the next element in the list to the <source lang="python" enclose=none>CounterVariable</source>. The code block associated with the loop is identified by a colon and indenting as described above.
+
and repeat for as many times as there are elements in the <source lang="python" enclose=none>ListOfValues</source>, each time assigning the next element in the list to the <source lang="python" enclose=none>LoopVariable</source>. The code block associated with the loop is identified by a colon and indenting as described above.
  
 
There are various ways of creating a list in Python. The <source lang="python" enclose=none>range</source> function can be used to create sequences of integers with a defined start, stop and step value. For example to create a list containing the four values 1, 4, 7 and 10, i.e. a sequence starting at 1 with steps of 3, use <source lang="python" enclose=none>range(1,11,3)</source>. Note that the stop value passed to the range function is not included in the list, i.e. <source lang="python" enclose=none>range(1,10,3)</source> would produce only the three numbers 1, 4 & 7. We can verify this at the Python command prompt, i.e.
 
There are various ways of creating a list in Python. The <source lang="python" enclose=none>range</source> function can be used to create sequences of integers with a defined start, stop and step value. For example to create a list containing the four values 1, 4, 7 and 10, i.e. a sequence starting at 1 with steps of 3, use <source lang="python" enclose=none>range(1,11,3)</source>. Note that the stop value passed to the range function is not included in the list, i.e. <source lang="python" enclose=none>range(1,10,3)</source> would produce only the three numbers 1, 4 & 7. We can verify this at the Python command prompt, i.e.
Line 69: Line 69:
 
[1, 4, 7]
 
[1, 4, 7]
 
</source>
 
</source>
This might seems strange, but makes more sense when we realise the start and step values are optional, and the range function assumes default values of 1 if they are not given, i.e.  <source lang="python" enclose=none>range(N)</source> returns <source lang="python" enclose=none>N</source> values starting at 1, e.g.
+
This might seems strange, but makes more sense when we realise the start and step values are optional, and the range function assumes default values of 1 for these if they are not given, i.e.  <source lang="python" enclose=none>range(N)</source> returns <source lang="python" enclose=none>N</source> values starting at 1, e.g.
 
<source lang="python">>>> range(5)
 
<source lang="python">>>> range(5)
 
[0, 1, 2, 3, 4]
 
[0, 1, 2, 3, 4]
Line 87: Line 87:
 
will repeatedly execute the code block for as long as <source lang="python" enclose=none>condition</source> is <source lang="python" enclose=none>True</source>.
 
will repeatedly execute the code block for as long as <source lang="python" enclose=none>condition</source> is <source lang="python" enclose=none>True</source>.
  
As in MATLAB, Python allows us to break out of for or while loops, or continues with the next iteration of a loop, using <source enclose=none lang="python">break</source> and <source enclose=none lang="python">continue</source> respectively.  
+
As in MATLAB, Python allows us to '''break''' out of for or while loops, or '''continue''' with the next iteration of a loop, using <source enclose=none lang="python">break</source> and <source enclose=none lang="python">continue</source> respectively.  
  
 
== <source lang="python" enclose=none>for </source> ==
 
== <source lang="python" enclose=none>for </source> ==
Line 120: Line 120:
  
  
One important difference to MATLAB is that Python list and array indexing starts at 0 and uses square brackets, whereas  array indices start at 1 in MATLAB. It is also important to understand that Python generally assumes a number to be integer unless there is something to indicate it is a floating point. Consider the line <source lang="python" enclose=none>y=[0.0]*T</source> that preallocates a Python list containing <source lang="python" enclose=none>T</source> '''floating point''' numbers all set to zero. If this had been written as <source lang="python" enclose=none>y=[0]*T</source> the list would contain instead <source lang="python" enclose=none>T</source> '''integers'''. We can demonstrate this at the Python prompt using the <source lang="python" enclose=none>type</source> function, which tells us the class of an object, e.g.
+
One important difference to MATLAB is that Python list and array indexing starts at 0 and indices are placed inside square brackets, whereas  array indices start at 1 in MATLAB. It is also important to understand that Python generally assumes a number to be integer unless there is something to indicate it is a floating point. Consider the line <source lang="python" enclose=none>y=[0.0]*T</source> that preallocates a Python list containing <source lang="python" enclose=none>T</source> '''floating point''' numbers all set to zero. If this had been written as <source lang="python" enclose=none>y=[0]*T</source> the list would contain <source lang="python" enclose=none>T</source> '''integers''' instead. We can demonstrate this at the Python prompt using the <source lang="python" enclose=none>type</source> function, which tells us the class of an object, e.g.
  
 
<source lang="python">>>>type(0.0)
 
<source lang="python">>>>type(0.0)
Line 177: Line 177:
  
 
== <source lang="python" enclose=none>while</source> ==
 
== <source lang="python" enclose=none>while</source> ==
the MATLAB code is
+
 
 +
The Python alternative of the above code using a conditional <source enclose=none lang="python">while</source> loop implements the following algorithm (remember that this contrived example is purely for demonstration purposes, and usually <source enclose=none lang="python">while</source> loops are used when the number of iterations is not known in advance).
 +
 
 +
# Find length of the list containing the error terms e: T=len(e)
 +
# Initialize a list <source enclose=none lang="python">y</source> with the same length as <source enclose=none lang="python">e</source>: <source enclose=none lang="python">y=[0.0]*T</source>
 +
# Check whether <source enclose=none lang="python">abs(phi1)<1</source>. If this statement is true, then <source enclose=none lang="python">y0=phi0/(1-phi1)</source>. Else, <source enclose=none lang="python">y0=0</source>.
 +
# Compute <source enclose=none lang="python">y[0]=phi0+phi1*y0+e[0]</source>.
 +
# Compute <source enclose=none lang="python">y[i]=phi0+phi1*y[i-1]+e[i]</source> for <math>i=1</math>
 +
# Repeat line 5 for <math>i=2,...,(T-1)</math>
 +
# Increase i by 1, i.e. <math>i=i+1</math>.
 +
# Repeat lines 5-6 whilst <math>i<=T</math>
 +
 
 +
The Python code
 +
<source lang="python">T=len(e)
 +
y=[0.0]*T
 +
y0=0.0
 +
if abs(phi1)<1:
 +
  y0=phi0/(1-phi1)
 +
y[0]=phi0+phi1*y0+e[0]
 +
i=1
 +
while i < T:
 +
  y[i]=phi0+phi1*y[i-1]+e[i]
 +
  i+=1
 +
</source>
 +
introduces a shorthand implemented in some other programming languages, e.g. C. The line <source enclose=none lang="python">i+=1</source> is shorthand for <source enclose=none lang="python">i=i+1</source>. This shorthand can be used with other operators, e.g. <source enclose=none lang="python">i*=10</source> is equivalent to typing <source enclose=none lang="python">i=i*10</source>.
 +
 
 +
For comparison, the MATLAB code is
  
 
<source>  T=size(e,1);
 
<source>  T=size(e,1);
 
   y=zeros(T,1);
 
   y=zeros(T,1);
 +
  y0=0;
 
   if abs(phi1)<1
 
   if abs(phi1)<1
 
   y0=phi0/(1-phi1);
 
   y0=phi0/(1-phi1);
  else
 
  y0=0;
 
  end
 
 
   y(1)=phi0+phi1*y0+e(1)
 
   y(1)=phi0+phi1*y0+e(1)
 
   i=2;
 
   i=2;

Revision as of 12:42, 11 October 2013

Preliminaries

One important thing to understand when programming in Python is that correct indenting of code is essential. The Python programming language was designed with readability in mind, and as a result forces you to indent code blocks, e.g.

  • while and for loops
  • if, elif, else constructs
  • functions

The indent for each block must be the same, the Python programming language also requires you to mark the start of a block with a colon. So where MATLAB used end to mark the end of a block of code, Python uses a change in indent. Other than this, simple Python programmes aren't dissimilar to those in MATLAB.

For example, the simplest case of an if conditional statement in Python would look something like this

if condition:
   statement1
   statement2
   ...

where the code in lines statement1, statement2, ... is executed only if condition is True. Sharp sighted readers might spot another difference to MATLAB, in general in Python there is no need to add a semicolon at the end of a line to suppress output, since Python produces no output for lines involving assignment (i.e. with the = sign).

The boolean condition can be built up using relational and logical operators. Relational operators in Python are similar to those in MATLAB, e.g. == tests for equality, > and >= test for greater than and greater than or equal to respectively. The main difference is that!= tests for inequality in Python, compared to ~= in MATLAB. Relational operators return boolean values of either True or False.

And Python's logical operators are and, or and not, which are hopefully self explanatory.

The if functionality can be expanded using else as follows

if condition:
   statement1
   statement2
   ...
else:
   statement1a
   statement2a
   ...

where statement1, statement2, ... is executed if condition is True, and statement1a, statement2a, ... is executed if condition is False. Note that the code block after the else starts with a colon, and this code block is also indented.

Finally, the most general form of this programming construct introduces the elif keyword (in contrast to elseif in MATLAB) to give

if condition1:
   statement1
   statement2
   ...
elif condition2:
   statement1a
   statement2a
   ...
   ...
   ...
elif conditionN:
   statement1b
   statement2b
   ...
else:
   statement1c
   statement2c
   ...

Like MATLAB, Python has while and for loops. Unconditional for loops iterate over a list of values

for LoopVariable in ListOfValues:
   statement1
   statement2
   ...

and repeat for as many times as there are elements in the ListOfValues, each time assigning the next element in the list to the LoopVariable. The code block associated with the loop is identified by a colon and indenting as described above.

There are various ways of creating a list in Python. The range function can be used to create sequences of integers with a defined start, stop and step value. For example to create a list containing the four values 1, 4, 7 and 10, i.e. a sequence starting at 1 with steps of 3, use range(1,11,3). Note that the stop value passed to the range function is not included in the list, i.e. range(1,10,3) would produce only the three numbers 1, 4 & 7. We can verify this at the Python command prompt, i.e.

>>> range(1,11,3)
[1, 4, 7, 10]
>>> range(1,10,3)
[1, 4, 7]

This might seems strange, but makes more sense when we realise the start and step values are optional, and the range function assumes default values of 1 for these if they are not given, i.e. range(N) returns N values starting at 1, e.g.

>>> range(5)
[0, 1, 2, 3, 4]
>>> range(10)
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

Python lists can also be created from a sequence of values separated by commas within square brackets, e.g. MyList = [1.0, "hello", 1] creates a list called MyList containing 3 values, a floating point number 1.0, the string hello and an integer 1. This example demonstrates that Python lists are general purpose containers, and that elements don't have to be of the same class. It is for this reason that lists are best avoided for numerical calculations unless they are relatively simple, as there are much more efficient containers for numbers, i.e. NumPy arrays, which will be introduced in due course.

Conditional while loops are identified with the while keyword, so

while condition:
   statement1
   statement2
   ...

will repeatedly execute the code block for as long as condition is True.

As in MATLAB, Python allows us to break out of for or while loops, or continue with the next iteration of a loop, using break and continue respectively.

for

We now look at the Python equivalents of the MATLAB code discussed in the MATLAB page on Program Flow and Logicals. A description of the mathematics is available on the MATLAB page, for brevity it is not repeated here. In the case when the error terms in e are known in advance, the Python version of the algorithm is:

  1. Find length of the list containing the error terms e: T=len(e)
  2. Initialize a list y with the same length as vector e: y=[0.0]*T
  3. Compute y[0]=phi0+phi1*y0+e[0]. Please remember, we assume that [math]y_0=E(y)=\phi_0/(1-\phi_1)[/math]
  4. Compute y[i]=phi0+phi1*y[i-1]+e[i] for [math]i=1[/math]
  5. Repeat line 4 for [math]i=2,...,(T-1)[/math]

A simple implementation in Python is

T=len(e)
y=[0.0]*T
y0=phi0/(1-phi1)
y[0]=phi0+phi1*y0+e[0]
for i in range(1,T):
   y[i]=phi0+phi1*y[i-1]+e[i]

and for comparison the MATLAB code is

  T=size(e,1);
  y=zeros(T,1);
  y0=phi0/(1-phi1);
  y(1)=phi0+phi1*y0+e(1);
  for i=2:T
    y(i)=phi0+phi1*y(i-1)+e(i);
  end


One important difference to MATLAB is that Python list and array indexing starts at 0 and indices are placed inside square brackets, whereas array indices start at 1 in MATLAB. It is also important to understand that Python generally assumes a number to be integer unless there is something to indicate it is a floating point. Consider the line y=[0.0]*T that preallocates a Python list containing T floating point numbers all set to zero. If this had been written as y=[0]*T the list would contain T integers instead. We can demonstrate this at the Python prompt using the type function, which tells us the class of an object, e.g.

>>>type(0.0)
<type 'float'>
>>> type(0)
<type 'int'>
>>> type(0e0)
<type 'float'>

Controversially, the behaviour of integer division changed in Python version 3, compared to version 2, and it is worth mentioning this now. In Python 2

>>>>>>type(1/2)
<class 'int'>
>>> 1/2
0

whereas in Python 3

>>>>>>type(1/2)
<class 'float'>
>>> 1/2
0.5

As Python 3 is expected to be the future of Python, we recommend using this version unless you have a good reason not to.

if else

As above, a description of the mathematics can be found on the MATLAB page on Program Flow and Logicals. The Python algorithm is now

  1. Find length of the list containing the error terms e: T=len(e)
  2. Initialize a list y with the same length as e: y=[0.0]*T
  3. Check whether abs(phi1)<1. If this statement is true, then y0=phi0/(1-phi1). Else, y0=0. Please remember, we set [math]y_0=E(y_0)[/math].
  4. Compute y[0]=phi0+phi1*y0+e[0].
  5. Compute y[i]=phi0+phi1*y[i-1]+e[i] for [math]i=1[/math]
  6. Repeat line 5 for [math]i=2,...,(T-1)[/math]

This can be implemented in Python as

T=len(e)
y=[0.0]*T
y0=0.0
if abs(phi1)<1:
   y0=phi0/(1-phi1)
y[0]=phi0+phi1*y0+e[0]
for i in range(1,T):
   y[i]=phi0+phi1*y[i-1]+e[i]

which is relatively similar to the MATLAB version

  T=size(e,1);
  y=zeros(T,1);
  y0=0;
  if abs(phi1)<1
  y0=phi0/(1-phi1);
  end
  y(1)=phi0+phi1*y0+e(1)
  for i=2:T
    y(i)=phi0+phi1*y(i-1)+e(i);
  end

while

The Python alternative of the above code using a conditional while loop implements the following algorithm (remember that this contrived example is purely for demonstration purposes, and usually while loops are used when the number of iterations is not known in advance).

  1. Find length of the list containing the error terms e: T=len(e)
  2. Initialize a list y with the same length as e: y=[0.0]*T
  3. Check whether abs(phi1)<1. If this statement is true, then y0=phi0/(1-phi1). Else, y0=0.
  4. Compute y[0]=phi0+phi1*y0+e[0].
  5. Compute y[i]=phi0+phi1*y[i-1]+e[i] for [math]i=1[/math]
  6. Repeat line 5 for [math]i=2,...,(T-1)[/math]
  7. Increase i by 1, i.e. [math]i=i+1[/math].
  8. Repeat lines 5-6 whilst [math]i\lt =T[/math]

The Python code

T=len(e)
y=[0.0]*T
y0=0.0
if abs(phi1)<1:
   y0=phi0/(1-phi1)
y[0]=phi0+phi1*y0+e[0]
i=1
while i < T:
   y[i]=phi0+phi1*y[i-1]+e[i]
   i+=1

introduces a shorthand implemented in some other programming languages, e.g. C. The line i+=1 is shorthand for i=i+1. This shorthand can be used with other operators, e.g. i*=10 is equivalent to typing i=i*10.

For comparison, the MATLAB code is

  T=size(e,1);
  y=zeros(T,1);
  y0=0;
  if abs(phi1)<1
  y0=phi0/(1-phi1);
  y(1)=phi0+phi1*y0+e(1)
  i=2;
  while i<=T
    y(i)=phi0+phi1*y(i-1)+e(i);
    i=i+1;
  end