Skip to content

Commit 1870c00

Browse files
author
camilo
committed
fixes
1 parent 7c0991e commit 1870c00

File tree

10 files changed

+3144
-113
lines changed

10 files changed

+3144
-113
lines changed

doc/Doxyfile_test

Lines changed: 2691 additions & 0 deletions
Large diffs are not rendered by default.

doc/qcrc.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,6 @@
3737
* std::string data = "123456789";
3838
* uint32_t crc_value;
3939
*
40-
* crc_value = crc::crc16_MODBUS( data.c_str(), data.length() );
40+
* crc_value = crc::crc16_KERMIT( data.c_str(), data.length() );
4141
* @endcode
4242
*/

doc/qfis.dox

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* combined into a single fuzzy set using the aggregation method of the FIS.
3232
* Then, to compute a final crisp output value, the combined output fuzzy set is
3333
* defuzzified using one of the methods described in Defuzzification Methods.
34-
* To specify a FIS of this type use the \ref qlibs::fisType::Mamdani enum definition when calling
34+
* To specify a FIS of this type use the \ref qlibs::Mamdani enum definition when calling
3535
* \ref qlibs::fis::setup().
3636
*
3737
* <center>
@@ -80,7 +80,7 @@
8080
* controllers that are to be applied, respectively, to different operating
8181
* conditions of a dynamic nonlinear system.
8282
*
83-
* To specificy a FIS of this type, use the \ref qlibs::fisType::Sugeno enum definition when
83+
* To specificy a FIS of this type, use the \ref qlibs::Sugeno enum definition when
8484
* calling \ref qlibs::fis::setup().
8585
*
8686
* <center>
@@ -111,7 +111,7 @@
111111
* each rule's output by the method of weighted average and thus avoids the
112112
* time-consuming process of defuzzification.
113113
*
114-
* To specify a FIS of this type, use the ::Tsukamoto enum definition when
114+
* To specify a FIS of this type, use the \ref qlibs::Tsukamoto enum definition when
115115
* calling \ref qlibs::fis::setup() .
116116
*
117117
* <center>
@@ -135,7 +135,7 @@
135135
* FIS supports five different methods, as listed in the \ref qlibs::fisDeFuzzMethod enum
136136
* for computing a single crisp output value for such a fuzzy set.
137137
*
138-
* -# \ref centroid (default): this method applies only to ::Mamdani
138+
* -# \ref qlibs::centroid (default): this method applies only to \ref qlibs::Mamdani
139139
* systems and returns the center of gravity of the fuzzy set along the x-axis.
140140
* If you think of the area as a plate with uniform thickness and density, the
141141
* centroid is the point along the x-axis about which the fuzzy set would balance.
@@ -145,21 +145,21 @@
145145
*
146146
* <center> \f$\text{centroid}= \frac{ \sum_{i=1}\mu(x_{i})x_{i} }{ \sum_{i=1}\mu(x_{i})} \f$ </center>
147147
*
148-
* -# \ref bisector : this method applies only for ::Mamdani systems and finds the
148+
* -# \ref qlibs::bisector : this method applies only for \ref qlibs::Mamdani systems and finds the
149149
* vertical line that divides the fuzzy set into two sub-regions of equal area.
150150
* It is sometimes, but not always, coincident with the centroid line.
151151
*
152-
* -# \ref mom : Middle of Maximum. Only for \ref Mamdani systems.
152+
* -# \ref qlibs::mom : Middle of Maximum. Only for \ref qlibs::Mamdani systems.
153153
*
154-
* -# \ref som : Smallest of Maximum. Only for \ref Mamdani systems.
154+
* -# \ref qlibs::som : Smallest of Maximum. Only for \ref qlibs::Mamdani systems.
155155
*
156-
* -# \ref lom : Largest of Maximum. Only for \ref Mamdani systems.
156+
* -# \ref qlibs::lom : Largest of Maximum. Only for \ref qlibs::Mamdani systems.
157157
*
158-
* -# \ref wtaver (default): Weighted average of all rule outputs. This method applies only
159-
* for \ref Sugeno and \ref Tsukamoto systems.
158+
* -# \ref qlibs::wtaver (default): Weighted average of all rule outputs. This method applies only
159+
* for \ref Sugeno and \ref qlibs::Tsukamoto systems.
160160
*
161-
* -# \ref qlibs::fisDeFuzzMethod::wtsum: Weighted sum of all rule outputs. This method applies only
162-
* for \ref qlibs::fisDeFuzzMethod::Sugeno and \ref Tsukamoto systems.
161+
* -# \ref qlibs::wtsum: Weighted sum of all rule outputs. This method applies only
162+
* for \ref qlibs::Sugeno and \ref qlibs::Tsukamoto systems.
163163
*
164164
* @note The defuzzification method is selected by default when setting up the
165165
* FIS instance with \ref qlibs::fis::setup(). However, the user can later change the default
@@ -301,7 +301,8 @@
301301
*
302302
* Then, we can proceed to the construction of the fuzzy system. First, we must
303303
* configure the inputs and outputs by setting the ranges of each. For this, we
304-
* will use the \ref fis::setupInput() and fis::setupOutput() methods as follows:
304+
* will use the \ref qlibs::fis::setupInput() and \ref qlibs::fis::setupOutput()
305+
* methods as follows:
305306
*
306307
* @code{.c}
307308
* tipper.setupInput( service, 0.0, 1.0 );
@@ -310,8 +311,8 @@
310311
* @endcode
311312
*
312313
* The next step is to configure the membership functions by relating I/O,
313-
* tags, shape and parameters one by one by using the \ref fis::setInputMF() and
314-
* fis::setOutputMF() methods as follows:
314+
* tags, shape and parameters one by one by using the \ref qlibs::fis::setInputMF() and
315+
* \ref qlibs::fis::setOutputMF() methods as follows:
315316
* Then, let's define the parameters of all the membership functions:
316317
*
317318
* @code{.c}
@@ -330,12 +331,12 @@
330331
*
331332
* @section qfis_eval Evaluating a Fuzzy Inference System
332333
*
333-
* If we already have a fuzzy system configured with \ref fis::setup(), we can
334-
* evaluate it by using \ref fis::fuzzify(), \ref fis::inference() and
335-
* \ref fis::deFuzzify().
336-
* Input values can be set with \ref fis::setInput() and output values can be
337-
* obtained with \ref fis::getOutput(). Also you can use the stream operator @c <<
338-
* to set the inputs and the index operator @c [] to get the outputs of the FIS
334+
* If we already have a fuzzy system configured with \ref qlibs::fis::setup(), we can
335+
* evaluate it by using \ref qlibs::fis::fuzzify(), \ref qlibs::fis::inference() and
336+
* \ref qlibs::fis::deFuzzify().
337+
* Input values can be set with \ref qlibs::fis::setInput() and output values can be
338+
* obtained with \ref qlibs::fis::getOutput(). Also you can use the stream operator @c <<
339+
* to set the inputs and the index operator [] to get the outputs of the FIS
339340
* system (see example bellow).
340341
*
341342
* To show its use, first we are going to put everything together in a single

doc/qfp16.dox

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,37 +28,37 @@
2828
*
2929
* - \ref qlibs::fp16::from() Convert int/float or double to the qlibs::fp16 type
3030
* - \ref qlibs::fp16::toInt() Convert qlibs::fp16 to integer.
31-
* - \ref qlibs::fp16::toFloat() Convert qlibs::p16 to float.
31+
* - \ref qlibs::fp16::toFloat() Convert qlibs::fp16 to float.
3232
* - \ref qlibs::fp16::toDouble() Convert qlibs::fp16 to double.
33-
* - \ref qlibs::fp16::toASCII() Convert from qlibs::fp16 to raw c-string.
33+
* - \ref fp16::toASCII() Convert from qlibs::fp16 to raw c-string.
3434
*
3535
* @subsection qfp16_basic_arithmetic Basic arithmetic
3636
*
3737
* Basic operator overloading also perform rounding and detect overflows. When
3838
* overflow is detected, they return @c overflow as a marker value.
3939
*
40-
* - (+) Addition
41-
* - (-) Subtraction
42-
* - (*) Multiplication
43-
* - (/) Division
40+
* - @c + Addition
41+
* - @c - Subtraction
42+
* - @c * Multiplication
43+
* - @c / Division
4444
*
4545
* @subsection qfp16_exp_functions Exponential and transcendental functions
4646
*
4747
* Roots, exponents & similar.
4848
*
4949
* - \ref qlibs::fp16::sqrt() Square root. Performs rounding and is accurate to fp16 limits.
5050
* - \ref qlibs::fp16::exp() Exponential function using power series approximation.
51-
* Accuracy depends on range, worst case +-40 absolute for negative inputs and
52-
* +-0.003% for positive inputs. Average error is +-1 for neg and +-0.0003% for pos.
51+
* Accuracy depends on range, worst case \c +-40 absolute for negative inputs and
52+
* @c +-0.003% for positive inputs. Average error is @c +-1 for neg and @c +-0.0003% for pos.
5353
* - \ref qlibs::fp16::log() Natural logarithm using Newton approximation and qlibs::fp16::exp().
54-
* Worst case error +-3 absolute, average error less than 1 unit.
54+
* Worst case error \c +-3 absolute, average error less than 1 unit.
5555
* - \ref qlibs::fp16::log2() Logarithm base 2.
5656
* - \ref qlibs::fp16::pow() Computes the power of a qlibs::fp16 number
5757
*
5858
*
5959
* @subsection qfp16_trig_functions Trigonometric functions and helpers
6060
*
61-
* - \ref qlibs::fp16::sin() Sine for angle in radians
61+
* - sin() Sine for angle in radians
6262
* - \ref qlibs::fp16::cos() Cosine for angle in radians
6363
* - \ref qlibs::fp16::tan() Tangent for angle in radians
6464
* - \ref qlibs::fp16::asin() Inverse of sine, output in radians

doc/qltisys.dox

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* transfer function models in real-valued systems.
55
* A transfer function is a model that describes the frequency-dependent response
66
* of a linear time-invariant system, and this class can handle both continuous-time
7-
* and discrete-time systems. \ref qlibs::qltisys can be used for simulating dynamic
7+
* and discrete-time systems. \ref qlibs::ltisys can be used for simulating dynamic
88
* systems and implementing filters, compensators, or controllers.
99
*
1010
* @section qltisys_cont Continous-time transfer functions
@@ -20,12 +20,12 @@
2020
* descending powers of \f$s\f$, respectively.
2121
*
2222
* To instantiate a continuous transfer function, you should define a variable
23-
* of type qlibs::continuousSystem, two arrays of N+1 elements with the coefficients of the
23+
* of type qlibs::continuousSystem, two arrays of @c N+1 elements with the coefficients of the
2424
* polynomials for both, the numerator and denominator, and finally, an array of type
25-
* \ref qlibs::continuousStates to hold the N states of the system.
26-
* Then, you can call \ref continuousSystem::setup() to construct the system and set initial
25+
* \ref qlibs::continuousStates to hold the @c N states of the system.
26+
* Then, you can call \ref qlibs::continuousSystem::setup() to construct the system and set initial
2727
* conditions. Subsequently, you can evaluate the system with a given input-signal
28-
* by just calling \ref continuousSystem::excite().
28+
* by just calling \ref qlibs::continuousSystem::excite() .
2929
*
3030
* @attention
3131
* The user must ensure that the

0 commit comments

Comments
 (0)