Paul Heidmann Fractal Example  1.0
fractalOne.hpp
Go to the documentation of this file.
1 #pragma once
2 
3 // Copyright (C) 2014 Paul S. Heidmann
4 //
5 // This program is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
14 //
15 // For a copy of the GNU General Public License see
16 // <http://www.gnu.org/licenses/>.
17 //
18 // Author contact info:
19 // Paul Heidmann
20 // paul@heidmann.com
21 
22 #include <memory>
23 #include <cstdint>
24 #include <complex>
25 
26 #include <fractalParams.hpp>
27 
28 /// \brief This namespace contains the equations and parameters that are
29 /// used to generate the first example fractal.
30 ///
31 /// This namespace contains the parameters and equations needed to generate
32 /// the first example fractal. This fractal uses the function:\n
33 /// \f$f(z) = z^5 - 5.0*z^4 - 55.0*z^3 + 245.0*z^2 + 654.0*z - 2520.0\f$ \n
34 /// which is:\n
35 /// \f$f(z) = (z + 6)*(z + 4)*(z - 3)*(z - 5)*(z - 7)\f$
36 /// \author Paul S. Heidmann
37 namespace fractalOne
38 {
39  typedef double fltType;
41  typedef std::complex<fltType> cmplxType;
42 
43  std::shared_ptr<fractalParamsType> getFractalParams( void );
44 }
fractal::fractalParams< fltType > fractalParamsType
Definition: fractalOne.hpp:40
double fltType
Definition: fractalOne.hpp:39
std::complex< fltType > cmplxType
Definition: fractalOne.hpp:41
This class is a container class for the parameters that are used to generate a fractal.
std::shared_ptr< fractalParamsType > getFractalParams(void)
Definition: fractalOne.cpp:78