Function description
List of functions in the src
folder.
- src.my_fibonacci(varargin)
Returns vector of n iterations of the Fibonacci sequence.
USAGE:
results = my_fibonacci(nb_iterations)
- Parameters:
foo (
positive integer
) – Optional argument. Number of iterations to run. Default = 5;- Returns:
- results:
(array) (1 x nb_iterations + 2)
Example:
results = my_fibonacci(5);
Utilities
- src.utils.is_octave()
Returns true if the environment is Octave.
USAGE:
retval = is_octave()
- src.utils.root_dir()
Returns fullpath the root of the repository.
USAGE:
retval = root_dir()
- Returns:
- root_dir:
(path)
- src.utils.get_version()
Reads the version number of the pipeline from the txt file in the root of the repository.
USAGE:
version_number = get_version()
- Returns:
- version_number:
(string) Use semantic versioning format (like v0.1.0)