Skip to content

Commit 08b301d

Browse files
author
camilo
committed
Doc fixes
1 parent 2489475 commit 08b301d

File tree

9 files changed

+38
-37
lines changed

9 files changed

+38
-37
lines changed

‎src/include/bitfield.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ namespace qlibs {
9292

9393
public:
9494
bitfield() = default;
95-
virtual ~bitfield() {}
95+
virtual ~bitfield() = default;
9696

9797
/**
9898
* @brief Setup a initialize a BitField instance.

‎src/include/fp16.hpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ namespace qlibs {
186186
inline fp16 operator++(int) noexcept
187187
{
188188
fp16 temp = *this;
189-
value = add( value, one );;
189+
value = add( value, one );
190190
return temp;
191191
}
192192
inline fp16& operator--() noexcept
@@ -197,7 +197,7 @@ namespace qlibs {
197197
inline fp16 operator--(int) noexcept
198198
{
199199
fp16 temp = *this;
200-
value = sub( value, one );;
200+
value = sub( value, one );
201201
return temp;
202202
}
203203
inline bool operator>(const fp16 &other) const noexcept

‎src/include/interp1.hpp‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,12 +103,12 @@ namespace qlibs {
103103
const real_t * const ty,
104104
const size_t tableSize );
105105
public:
106-
virtual ~interp1() {}
106+
virtual ~interp1() = default;
107107
/**
108108
* @brief Constructor for the 1D interpolation instance.
109109
* @param[in] xTable An array of size @a sizeTable with the x points sorted in ascending order.
110110
* @param[in] yTable An array of size @a sizeTable with the y points.
111-
* @param[in] sizeTable The number of points in @a xTable @a yTable
111+
* @param[in] sizeTable The number of points in @a xTable and @a yTable
112112
*/
113113
interp1( const real_t * const xTable,
114114
const real_t * const yTable,
@@ -127,7 +127,7 @@ namespace qlibs {
127127
* @brief Set the data table for the 1D interpolation instance.
128128
* @param[in] xTable An array of size @a sizeTable with the x points sorted in ascending order.
129129
* @param[in] yTable An array of size @a sizeTable with the y points.
130-
* @param[in] sizeTable The number of points in @a xTable @a yTable
130+
* @param[in] sizeTable The number of points in @a xTable and @a yTable
131131
*/
132132
bool setData( const real_t * const xTable,
133133
const real_t * const yTable,
@@ -162,15 +162,15 @@ namespace qlibs {
162162
* @return @c true on success otherwise @c false.
163163
*/
164164
bool setMethod( const interp1Method m ) noexcept;
165-
template <typename T>
166165

167166
/**
168167
* @brief Interpolate input point @a x to determine the value of @a y
169168
* at the points @a xi using the current method. If value is beyond
170169
* the endpoints, extrapolation is performed using the current method.
171170
* @param[in] x The input point.
172-
* @return @c The interpolated-extrapolated @a y value.
171+
* @return @c The interpolated or extrapolated @a y value.
173172
*/
173+
template <typename T>
174174
inline real_t get( const T x ) noexcept
175175
{
176176
return method( static_cast<real_t>( x ), xData, yData, dataSize );

‎src/include/ltisys.hpp‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ namespace qlibs {
6767

6868
/**
6969
* @brief Constructor for the continuousTF class
70-
* @param[in] numerator An array of size @c order with the coefficients
70+
* @param[in] numerator An array of size @c order+1 with the coefficients
7171
* of the numerator in descending powers of s.
72-
* @param[in] denominator An array of size @c order with the coefficients
72+
* @param[in] denominator An array of size @c order+1 with the coefficients
7373
* of the denominator in descending powers of s.
7474
*/
7575
continuousTF( const real_t ( &numerator )[ order + 1 ], const real_t ( &denominator )[ order + 1 ] )
@@ -203,9 +203,9 @@ namespace qlibs {
203203
* Example :
204204
* @code{.cpp}
205205
* constexpr real_t dt = 0.1_re;
206-
* transportDelay< 2.5_td(dt) )> myDelay1;
207-
* transportDelay< delayFromTime(5.2, dt) )> myDelay2;
208-
* transportDelay< 4.3_td[dt] )> myDelay2;
206+
* transportDelay< 2.5_td(dt) > myDelay1;
207+
* transportDelay< delayFromTime(5.2, dt) > myDelay2;
208+
* transportDelay< 4.3_td[dt] > myDelay2;
209209
* @endcode
210210
*/
211211
template<size_t numberOfDelays>
@@ -371,7 +371,7 @@ namespace qlibs {
371371
* @return @c true if the system has been initialized, otherwise
372372
* return @c false.
373373
*/
374-
virtual bool isInitialized( void ) const = 0;
374+
virtual bool isInitialized( void ) const noexcept = 0;
375375

376376

377377
/**
@@ -582,7 +582,7 @@ namespace qlibs {
582582
* @return @c true if the system has been initialized, otherwise
583583
* return @c false.
584584
*/
585-
bool isInitialized( void ) const override
585+
bool isInitialized( void ) const noexcept override
586586
{
587587
return ( nullptr != xd ) && ( LTISYS_TYPE_DISCRETE == type );
588588
}
@@ -791,7 +791,7 @@ namespace qlibs {
791791
* @return @c true if the system has been initialized, otherwise
792792
* return @c false.
793793
*/
794-
bool isInitialized( void ) const override
794+
bool isInitialized( void ) const noexcept override
795795
{
796796
return ( nullptr != xc ) && ( LTISYS_TYPE_CONTINUOUS == type );
797797
}

‎src/include/numa.hpp‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ namespace qlibs {
2727
*/
2828
enum integrationMethod {
2929
INTEGRATION_RECTANGULAR, /*!< Numerical integration using the rectangular rule*/
30-
INTEGRATION_TRAPEZOIDAL, /*!< Numerical integration using the trapezoidal rectangular rule*/
30+
INTEGRATION_TRAPEZOIDAL, /*!< Numerical integration using the trapezoidal rule*/
3131
INTEGRATION_SIMPSON, /*!< Numerical integration using the Simpson's 1/3 rule.*/
3232
INTEGRATION_QUADRATIC, /*!< Numerical integration using a parabola fit to three points.*/
3333
};
@@ -60,13 +60,13 @@ namespace qlibs {
6060
integrationMethod iMethod{ INTEGRATION_TRAPEZOIDAL };
6161
derivationMethod dMethod{ DERIVATION_2POINTS };
6262
public:
63-
virtual ~nState() {}
63+
virtual ~nState() = default;
6464

6565
/**
6666
* @brief Constructor for the state object
67-
* @param[in] x0 initial condition at time t(0)
68-
* @param[in] sn_1 initial condition at time (t-1)
69-
* @param[in] sn_2 initial condition at time (t-2)
67+
* @param[in] x0 Initial condition at time t(0)
68+
* @param[in] sn_1 Initial condition at time (t-1)
69+
* @param[in] sn_2 Initial condition at time (t-2)
7070
*/
7171
nState( const real_t x0 = 0.0_re,
7272
const real_t sn_1 = 0.0_re,
@@ -77,9 +77,9 @@ namespace qlibs {
7777

7878
/**
7979
* @brief Initialize the state object
80-
* @param[in] x0 initial condition at time t(0)
81-
* @param[in] sn_1 initial condition at time (t-1)
82-
* @param[in] sn_2 initial condition at time (t-2)
80+
* @param[in] x0 Initial condition at time t(0)
81+
* @param[in] sn_1 Initial condition at time (t-1)
82+
* @param[in] sn_2 Initial condition at time (t-2)
8383
*/
8484
void init( const real_t x0 = 0.0_re,
8585
const real_t sn_1 = 0.0_re,
@@ -236,7 +236,7 @@ namespace qlibs {
236236
private:
237237
real_t dt;
238238
public:
239-
virtual ~integrator() {}
239+
virtual ~integrator() = default;
240240

241241
/**
242242
* @brief Constructs an integrator block with a given @a timeStep time
@@ -278,7 +278,7 @@ namespace qlibs {
278278
private:
279279
real_t dt;
280280
public:
281-
virtual ~derivative() {}
281+
virtual ~derivative() = default;
282282

283283
/**
284284
* @brief Constructs a derivative block with a given @a timeStep and

‎src/include/pid.hpp‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ namespace qlibs {
301301
* pidMode::PID_MANUAL mode, the manual input will be used as the control
302302
* signal for the process and the PID controller loop will continue
303303
* operating to guarantee the bumpless-transfer when a switch to
304-
* the pidMode::PID_AUTOMATIC its performed;
304+
* the pidMode::PID_AUTOMATIC is performed;
305305
* @param[in] Mode The desired operational mode.
306306
* @return @c true on success, otherwise return @c false.
307307
*/
@@ -333,15 +333,16 @@ namespace qlibs {
333333
* @brief Enable the additive MRAC(Model Reference Adaptive Control) feature.
334334
* @param[in] modelRef A pointer to the output of the model reference.
335335
* @param[in] Gamma Adjustable parameter to indicate the adaptation speed.
336-
* @param[in] Alpha Adjustable parameter the adaptation momentum.
336+
* @param[in] Alpha Adjustable parameter for the adaptation momentum.
337337
* @return @c true on success, otherwise return @c false.
338338
*/
339339
bool setModelReferenceControl( const real_t &modelRef,
340340
const real_t Gamma = 0.5_re,
341341
const real_t Alpha = 0.01_re ) noexcept;
342342

343343
/**
344-
* @brief Removes the Enable the additive
344+
* @brief Removes the additive MRAC(Model Reference Adaptive Control)
345+
* feature from the control loop.
345346
* MRAC(Model Reference Adaptive Control) feature from the control loop.
346347
* @return @c true on success, otherwise return @c false.
347348
*/
@@ -399,7 +400,7 @@ namespace qlibs {
399400
/**
400401
* @brief Set the number of time steps where the auto tuner algorithm will
401402
* modify the controller gains.
402-
* @pre Controller must have an pidAutoTuning object already binded wih
403+
* @pre Controller must have a pidAutoTuning object already binded with
403404
* pidController::bindAutoTuning()
404405
* @note To disable auto-tuning pass a 0uL value to the @a tEnable argument.
405406
* @param[in] tEnable The number of time steps. To keep the auto tuner

‎src/include/rms.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ namespace qlibs {
2929
*/
3030
class rms : public smootherEXPW, public smootherMWM2, public smootherLPF1 {
3131
public:
32-
virtual ~rms() {}
32+
virtual ~rms() noexcept = default;
3333
rms() = default;
3434

3535
/**

‎src/include/smoother.hpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ namespace qlibs {
6565
virtual real_t smooth( const real_t x ) = 0;
6666

6767
/**
68-
* @brief Reset the the smoother filter.
68+
* @brief Reset the smoother filter.
6969
* @return @c true on success, otherwise return false.
7070
*/
7171
inline bool reset( void )
@@ -497,7 +497,7 @@ namespace qlibs {
497497
* @param[in] wsize The size of the @a window array
498498
* @param[in] window An array to store the window samples.
499499
* @param[in] weights An array to store the filter weights
500-
* @param[in] w1 An array to keep previous estimated wights. To ignore
500+
* @param[in] w1 An array to keep previous estimated weights. To ignore
501501
* pass @c nullptr as argument.
502502
* @return @c true on success, otherwise return @c false.
503503
*/
@@ -514,7 +514,7 @@ namespace qlibs {
514514
* @param[in] m Momentum [ 0 < @a m < 1 ]
515515
* @param[in] window An array to store the window samples.
516516
* @param[in] weights An array to store the filter weights
517-
* @param[in] w1 An array to keep previous estimated wights.
517+
* @param[in] w1 An array to keep previous estimated weights.
518518
* @return @c true on success, otherwise return @c false.
519519
*/
520520
template <size_t windowSize>

‎src/include/tdl.hpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ namespace qlibs {
4242
void removeOldest( void ) noexcept;
4343
/*! @endcond */
4444
public:
45-
virtual ~tdl() {}
45+
virtual ~tdl() noexcept = default;
4646
tdl() = default;
4747

4848
/**
@@ -53,7 +53,7 @@ namespace qlibs {
5353
*/
5454
tdl( real_t * const area,
5555
const size_t n,
56-
const real_t initVal = 0.0_re )
56+
const real_t initVal = 0.0_re ) noexcept
5757
{
5858
setup( area, n, initVal );
5959
}
@@ -145,7 +145,7 @@ namespace qlibs {
145145
* @brief Check if the TDL has been initialized.
146146
* @return @c true if instance has been initialized
147147
*/
148-
bool isInitialized( void ) const {
148+
bool isInitialized( void ) const noexcept {
149149
return ( nullptr != head );
150150
}
151151

0 commit comments

Comments
 (0)