Skip to content

Commit 28b2def

Browse files
author
camilo
committed
added cyl_neumann to ffmath. Updated doc. Bump to 1.3.0
1 parent 9b06a0e commit 28b2def

10 files changed

+48
-13
lines changed

doc/Doxyfile

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ DOXYFILE_ENCODING = UTF-8
4242
# title of most generated pages and in a few other places.
4343
# The default value is: My Project.
4444

45-
PROJECT_NAME = "API Reference"
45+
PROJECT_NAME = "Documentation"
4646

4747
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = v1.0
51+
PROJECT_NUMBER =
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a

doc/Doxyfile_test

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ DOXYFILE_ENCODING = UTF-8
4242
# title of most generated pages and in a few other places.
4343
# The default value is: My Project.
4444

45-
PROJECT_NAME = "API Reference"
45+
PROJECT_NAME = "Documentation"
4646

4747
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = v1.0
51+
PROJECT_NUMBER =
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a

doc/qffmath.dox

+1
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@
9494
* - \ref qlibs::ffmath::cyl_bessel_i() Computes the regular modified cylindrical Bessel function
9595
* - \ref qlibs::ffmath::cyl_bessel_j() Computes the cylindrical Bessel function of the first kind
9696
* - \ref qlibs::ffmath::cyl_bessel_k() Computes the irregular modified cylindrical Bessel function
97+
* - \ref qlibs::ffmath::cyl_neumann() Computes the cylinkdrical Neumann function.
9798
* - \ref qlibs::ffmath::sph_legendre() Computes the spherical associated Legendre function
9899
*
99100
* @subsection qffmath_const Constants

library.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"maintainer": true
1717
}
1818
],
19-
"version": "1.2.9",
19+
"version": "1.3.0",
2020
"license": "MIT",
2121
"frameworks": "arduino",
2222
"platforms": "*"

library.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=qlibs
2-
version=1.2.9
2+
version=1.3.0
33
license=MIT
44
author=J. Camilo Gomez C. <[email protected]>
55
maintainer=J. Camilo Gomez C. <[email protected]>

src/CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
cmake_minimum_required( VERSION 3.2 )
22
project( qlibs-cpp
3-
VERSION 1.2.9
3+
VERSION 1.3.0
44
DESCRIPTION "A collection of useful C++ libraries for embedded systems"
55
LANGUAGES CXX )
66

src/ffmath.cpp

+22-1
Original file line numberDiff line numberDiff line change
@@ -2781,6 +2781,28 @@ float ffmath::cyl_bessel_k( float nu,
27812781
return y;
27822782
}
27832783
/*============================================================================*/
2784+
float ffmath::cyl_neumann( float nu,
2785+
float x )
2786+
{
2787+
float y;
2788+
2789+
if ( ( nu < 0.0F ) || ( x < 0.0F ) || ffmath::isNan( nu ) || ffmath::isNan( x ) ) {
2790+
y = ffmath::getNan();
2791+
}
2792+
else if ( x > 1000.0F ) {
2793+
float J_nu, N_nu;
2794+
cyl_bessel_jn_asymp( nu, x, J_nu, N_nu );
2795+
y = N_nu;
2796+
}
2797+
else {
2798+
float J_nu, N_nu, Jp_nu, Np_nu;
2799+
2800+
bessel_jn( nu, x, J_nu, N_nu, Jp_nu, Np_nu );
2801+
y = N_nu;
2802+
}
2803+
return y;
2804+
}
2805+
/*============================================================================*/
27842806
float ffmath::sph_legendre( size_t l,
27852807
size_t m,
27862808
float theta )
@@ -2854,4 +2876,3 @@ float ffmath::sph_legendre( size_t l,
28542876
}
28552877
return y;
28562878
}
2857-
/*============================================================================*/

src/include/ffmath.hpp

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*!
22
* @file ffmath.hpp
33
* @author J. Camilo Gomez C.
4-
* @version 1.06
4+
* @version 1.07
55
* @note This file is part of the qLibs++ distribution.
66
* @brief Fast floating-point math library for applications where speed is more
77
* important than accuracy
@@ -1005,6 +1005,19 @@ namespace qlibs {
10051005
float cyl_bessel_k( float nu,
10061006
float x );
10071007

1008+
/**
1009+
* @brief Computes the cylindrical Neumann function ( also known as Bessel
1010+
* function of the second kind or Weber function) of @a nu and @a x.
1011+
* @param[in] nu The order of the function
1012+
* @param[in] x The argument to the function, a floating-point or integer value
1013+
* @return Upon successful completion, the value of the cylindrical Neumann
1014+
* function ( Bessel function of the second kind) of @a nu
1015+
* and @a x. If the argument is @c nan, a @c nan is returned. If @a nu is
1016+
* greater or equal than @c 128, the behavior is implementation-defined.
1017+
*/
1018+
float cyl_neumann( float nu,
1019+
float x );
1020+
10081021
/**
10091022
* @brief 1-3) Computes the spherical associated Legendre function of
10101023
* degree @a l, order @a m, and polar angle @a theta

src/qlibs.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*!
22
* @file qlibs.h
33
* @author J. Camilo Gomez C.
4-
* @version 1.2.9
4+
* @version 1.3.0
55
* @note This file is part of the qlibs++ distribution.
66
* @brief Global inclusion header
77
**/
@@ -41,8 +41,8 @@ This file is part of the QuarkTS++ OS distribution.
4141
#ifndef QLIBS_CPP_H
4242
#define QLIBS_CPP_H
4343

44-
#define QLIBS_CPP_VERSION "1.2.9"
45-
#define QLIBS_CPP_VERNUM ( 129U )
44+
#define QLIBS_CPP_VERSION "1.3.0"
45+
#define QLIBS_CPP_VERNUM ( 130U )
4646
#define QLIBS_CPP_CAPTION "qLibs++" QLIBS_CPP_VERSION
4747

4848
#include <include/qlibs_types.hpp>

0 commit comments

Comments
 (0)