Skip to content

Commit

Permalink
added cyl_neumann to ffmath. Updated doc. Bump to 1.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
camilo committed May 7, 2024
1 parent 9b06a0e commit 28b2def
Show file tree
Hide file tree
Showing 10 changed files with 48 additions and 13 deletions.
4 changes: 2 additions & 2 deletions doc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "API Reference"
PROJECT_NAME = "Documentation"

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

PROJECT_NUMBER = v1.0
PROJECT_NUMBER =

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
4 changes: 2 additions & 2 deletions doc/Doxyfile_test
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "API Reference"
PROJECT_NAME = "Documentation"

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

PROJECT_NUMBER = v1.0
PROJECT_NUMBER =

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
1 change: 1 addition & 0 deletions doc/qffmath.dox
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@
* - \ref qlibs::ffmath::cyl_bessel_i() Computes the regular modified cylindrical Bessel function
* - \ref qlibs::ffmath::cyl_bessel_j() Computes the cylindrical Bessel function of the first kind
* - \ref qlibs::ffmath::cyl_bessel_k() Computes the irregular modified cylindrical Bessel function
* - \ref qlibs::ffmath::cyl_neumann() Computes the cylinkdrical Neumann function.
* - \ref qlibs::ffmath::sph_legendre() Computes the spherical associated Legendre function
*
* @subsection qffmath_const Constants
Expand Down
2 changes: 1 addition & 1 deletion doc/stylesheet
2 changes: 1 addition & 1 deletion library.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"maintainer": true
}
],
"version": "1.2.9",
"version": "1.3.0",
"license": "MIT",
"frameworks": "arduino",
"platforms": "*"
Expand Down
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=qlibs
version=1.2.9
version=1.3.0
license=MIT
author=J. Camilo Gomez C. <kmilo17pet@gmail.com>
maintainer=J. Camilo Gomez C. <kmilo17pet@gmail.com>
Expand Down
2 changes: 1 addition & 1 deletion src/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cmake_minimum_required( VERSION 3.2 )
project( qlibs-cpp
VERSION 1.2.9
VERSION 1.3.0
DESCRIPTION "A collection of useful C++ libraries for embedded systems"
LANGUAGES CXX )

Expand Down
23 changes: 22 additions & 1 deletion src/ffmath.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2781,6 +2781,28 @@ float ffmath::cyl_bessel_k( float nu,
return y;
}
/*============================================================================*/
float ffmath::cyl_neumann( float nu,
float x )
{
float y;

if ( ( nu < 0.0F ) || ( x < 0.0F ) || ffmath::isNan( nu ) || ffmath::isNan( x ) ) {
y = ffmath::getNan();
}
else if ( x > 1000.0F ) {
float J_nu, N_nu;
cyl_bessel_jn_asymp( nu, x, J_nu, N_nu );
y = N_nu;
}
else {
float J_nu, N_nu, Jp_nu, Np_nu;

bessel_jn( nu, x, J_nu, N_nu, Jp_nu, Np_nu );
y = N_nu;
}
return y;
}
/*============================================================================*/
float ffmath::sph_legendre( size_t l,
size_t m,
float theta )
Expand Down Expand Up @@ -2854,4 +2876,3 @@ float ffmath::sph_legendre( size_t l,
}
return y;
}
/*============================================================================*/
15 changes: 14 additions & 1 deletion src/include/ffmath.hpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*!
* @file ffmath.hpp
* @author J. Camilo Gomez C.
* @version 1.06
* @version 1.07
* @note This file is part of the qLibs++ distribution.
* @brief Fast floating-point math library for applications where speed is more
* important than accuracy
Expand Down Expand Up @@ -1005,6 +1005,19 @@ namespace qlibs {
float cyl_bessel_k( float nu,
float x );

/**
* @brief Computes the cylindrical Neumann function ( also known as Bessel
* function of the second kind or Weber function) of @a nu and @a x.
* @param[in] nu The order of the function
* @param[in] x The argument to the function, a floating-point or integer value
* @return Upon successful completion, the value of the cylindrical Neumann
* function ( Bessel function of the second kind) of @a nu
* and @a x. If the argument is @c nan, a @c nan is returned. If @a nu is
* greater or equal than @c 128, the behavior is implementation-defined.
*/
float cyl_neumann( float nu,
float x );

/**
* @brief 1-3) Computes the spherical associated Legendre function of
* degree @a l, order @a m, and polar angle @a theta
Expand Down
6 changes: 3 additions & 3 deletions src/qlibs.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*!
* @file qlibs.h
* @author J. Camilo Gomez C.
* @version 1.2.9
* @version 1.3.0
* @note This file is part of the qlibs++ distribution.
* @brief Global inclusion header
**/
Expand Down Expand Up @@ -41,8 +41,8 @@ This file is part of the QuarkTS++ OS distribution.
#ifndef QLIBS_CPP_H
#define QLIBS_CPP_H

#define QLIBS_CPP_VERSION "1.2.9"
#define QLIBS_CPP_VERNUM ( 129U )
#define QLIBS_CPP_VERSION "1.3.0"
#define QLIBS_CPP_VERNUM ( 130U )
#define QLIBS_CPP_CAPTION "qLibs++" QLIBS_CPP_VERSION

#include <include/qlibs_types.hpp>
Expand Down

0 comments on commit 28b2def

Please sign in to comment.