/**
\mainpage

@author Enzo De Sena, enzodesena@me.com

MCL is a C++ library that implements many of Matlab's functions. The library 
is written so as to minimise the time needed to port Matlab code to C++. 
The  main point of departure between the two is that c++ requires the definition 
of the types you are using. In MCL we have three types: Real, Int, Complex. 
Furthermore, vectors start from 0 instead of 1.
The library has been written following Google's C++ style guide:
http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml

## Examples ## 

A sample of how to use the library is:

\code{.cpp}
std::vector<Real> my_vector_a;
my_vector_a = Zeros<Real>(3);                   // my_vector_a = zeros(3,1);
my_vector_a[0] = 2.5;                           // my_vector_a(1) = 2.5;
my_vector_a[1] = 0.0;                           // my_vector_a(2) = 0.0;
my_vector_a[2] = -2.4;                          // my_vector_a(3) = -2.4;

Real max_value = Max(my_vector);                // max_value = max(my_vector);
// max_value is 2.5

Real mean_value = Mean(my_vector);              // mean_value = mean(my_vector);

std::vector<Real> my_vector_b;
my_vector_b = Zeros<Real>(3);                   // my_vector_b = zeros(3,1);
my_vector_b[0] = 1.0;                           // my_vector_b(1) = 1.0;
my_vector_b[1] = 0.0;                           // my_vector_b(2) = 0.0;
my_vector_b[2] = 2.4;                           // my_vector_b(3) = 2.4;

std::vector<Real> my_vector_add;
my_vector_add = Add(my_vector_a, my_vector_b); // my_vector_add = 
                                               //     my_vector_a+my_vector_b

// Convert to complex vector
std::vector<Complex> my_vector_c = ComplexVector(my_vector_a);

// Computes the FFT on 16 points
std::vector<Complex> my_vector_fft;
my_vector_fft = Fft(my_vector_c, 16);          // my_vector_fft = fft(my_vector_c, 16);
std::vector<Real> my_vector_fft_abs;
my_vector_fft_abs = Abs(my_vector_fft);        // my_vector_fft_abs = abs(my_vector_fft);     

std::vector<Real> my_vector_conv;
my_vector_conv = Conv(my_vector_a, my_vector_b);// my_vector_conv = 
                                               //      conv(my_vector_a, my_vector_b);


// Some more advanced functions
std::vector<Real> my_vector_rceps;
my_vector_rceps = RCeps(my_vector);            // my_vector_rceps = rceps(my_vector);

std::vector<Complex> my_vector_hilbert;
my_vector_hilbert = Hilbert(my_vector);        // my_vector_hilbert = hilbert(my_vector);
\endcode


## License ## 

Copyright (c) 2018, Enzo De Sena

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    * Use is for nonprofit educational purposes or for nonprofit research purposes only.
    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    * Neither the author nor the names of any contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Please notice that this is not a standard 3-clause BSD license, due to the first condition above (nonprofit use).
*/