Skip to content
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
0adc5a6
Update mathieu.h with improved docstrings and comments.
brorson Sep 6, 2025
9f62cf0
Add new directory of Mathieu fcn impls.
brorson Sep 6, 2025
204e09d
Make sure we return nan when error is encountered.
brorson Sep 6, 2025
b09c280
Remove non-standard d in double constant literals.
brorson Sep 7, 2025
41c1f28
Merge branch 'scipy:main' into main
brorson Sep 10, 2025
93a41df
Remove license file and place code under whatever license xsf uses.
brorson Sep 10, 2025
b8911c1
Merge branch 'main' of https://github.com/brorson/xsf_mathieu
brorson Sep 10, 2025
5cbf45c
I removed my Makefile since it's not used in the Scipy CI tool. I moved
brorson Sep 11, 2025
cdf598b
Run clang-format on test_mathieu.cpp so it passes CI.
brorson Sep 11, 2025
cec5ca1
Merge branch 'scipy:main' into main
brorson Sep 24, 2025
9c850da
Replaced malloc/free with std::vector, updated some comments, added
brorson Sep 26, 2025
72a5146
Merge branch 'main' of https://github.com/brorson/xsf_mathieu
brorson Sep 26, 2025
b25ba42
Merge branch 'scipy:main' into main
brorson Sep 26, 2025
e32d63c
Remove mathieu.h since it doesn't belong in this dir.
brorson Sep 27, 2025
7614c4e
run clang-format on all .h files.
brorson Sep 27, 2025
f96e616
Change dsyev -> dsyevd to speed up calc.
brorson Nov 13, 2025
5ddc975
Change dsyevd to dstevd since dstevd is for tridiagonal matrices,
brorson Nov 13, 2025
67314ef
Revert back to dsyevd. Use correct calling sig this time.
brorson Nov 15, 2025
c5e098b
Clean up files using clang-format before checking in.
brorson Nov 16, 2025
7873a34
Merge branch 'scipy:main' into main
brorson Nov 16, 2025
78ce632
I used a more recent version of clang-format. Hopefully this will
brorson Nov 16, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
585 changes: 357 additions & 228 deletions include/xsf/mathieu.h

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions include/xsf/mathieu/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Stuart Brorson

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
36 changes: 36 additions & 0 deletions include/xsf/mathieu/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
CC := g++
# CC := gcc
CFLAGS := -O3 -std=c++17 -fno-fast-math -march=x86-64 -m128bit-long-double
#CFLAGS := -O3 -std=c++17 -fno-fast-math -mfpmath=sse -march=x86-64 -m128bit-long-double

SRCS := $(wildcard *.c)
OBJS := $(SRCS:.c=.o)
EXES := main
TARGETS = main
INCLUDES := -I. -I/usr/include -I/usr/local/include
LDFLAGS := -L/usr/lib/x86_64-linux-gnu/lapack/
#LDFLAGS := -L/usr/lib/x86_64-linux-gnu/openblas-pthread/ -L/usr/lib -L/usr/local/lib
#INCLUDES := -I. -I/usr/include/x86_64-linux-gnu/
#LDFLAGS := -L/usr/lib/x86_64-linux-gnu
LIBS := -llapacke -llapack -lblas -lm


#=================================================
all: $(TARGETS)

# Link all object files into the executable
$(TARGETS): $(OBJS)
$(CC) $(OBJS) -o $@ $(CFLAGS) $(LDFLAGS) $(LIBS)

# Compile each .c into a .o
%.o: %.c %.h
$(CC) $(CFLAGS) $(INCLUDES) -c $< -o $@

# Also handle .c files without headers
%.o: %.c
$(CC) $(CFLAGS) $(INCLUDES) -c $< -o $@

#-------------------------------
# Clean up directory -- remove executables and intermediate files.
clean:
-rm -f *~ *.o *.obj *.out *.map *.h.gch $(TARGETS) $(OBJS)
39 changes: 39 additions & 0 deletions include/xsf/mathieu/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
This is an implementation of the Mathieu fcns in C/C++. The
implementation follows the prototype algos created in Matlab and
maintained on GitHub at
https://github.com/brorson/MathieuFcnsFourier. This impl is a
header-only library for compatability with Scipy's xsf library.

The following Mathieu fcns are implemented:

* Angular fcn ce(n,q,v)
* Angular fcn se(n,q,v)
* Radial (modified) fcn of first kind mc1(n,q,u)
* Radial (modified) fcn of first kind ms1(n,q,u)
* Radial (modified) fcn of second kind mc2(n,q,u)
* Radial (modified) fcn of second kind ms2(n,q,u)

Here, n = fcn order, q = frequency (geometry) parmeter, v = angular
coord (radians), u = radial coord (au).

I also provide the following utility fcns:

* Eigenvalue a_n(q)
* Eigenvalue b_n(q)
* Fourier coeffs A_n^k(q) for ce fcns
* Fourier coeffs B_n^k(q) for se fcns

The goal is to provide a replacement of the Mathieu fcn suite used by
Scipy.

These programs may be built the usual way on a Linux system using the
usual GNU build tools. The main() function runs some simple sanity
checks on the functions. In particular, it verifies some output
values against those computed by the Matlab programs. I did a lot of
verification and accuracy testing on the Matlab implementations.
Therefore, tests run here just make sure the C implementation's
outputs match those from Matlab. The code in main() also shows how to
invoke the various fcns.

Summer 2025, SDB

85 changes: 85 additions & 0 deletions include/xsf/mathieu/besseljyd.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
#ifndef BESSELJYD_H
#define BESSELJYD_H

#include "../config.h"
#include "../bessel.h"


/*
*
* This is part of the Mathieu function suite -- a reimplementation
* of the Mathieu functions for Scipy. This file holds helpers
* to the Bessel J and Y functions and also returns derivatives
* of those fcns.
*
*/

namespace xsf {
namespace mathieu {

//==================================================================
double besselj(int k, double z) {
// This is just a thin wrapper around the Bessel impl in the
// std library.
double v = (double) k;
return xsf::cyl_bessel_j(v, z);
}

//==================================================================
double bessely(int k, double z) {
// This is just a thin wrapper around the Bessel impl in the
// std library.
double v = (double) k;
return xsf::cyl_bessel_y(v, z);
}

//==================================================================
double besseljd(int k, double z) {
// This returns the derivative of besselj. The deriv is
// computed using common identities.
double y;

if (k == 0) {
double v = 1.0;
y = -besselj(v,z);
} else {
double kp1 = (double) (k+1);
double km1 = (double) (k-1);
y = (besselj(km1,z)-besselj(kp1,z))/2.0;
}

// Must flip sign for negative k and odd k.
if (k<0 && ((k % 2) != 0)) {
y = -y;
}

return y;
}

//==================================================================
double besselyd(int k, double z) {
// This returns the derivative of besselj. The deriv is
// computed using common identities.
double y;

if (k == 0) {
double v = 1.0;
y = -bessely(v,z);
} else {
double kp1 = (double) (k+1);
double km1 = (double) (k-1);
y = (bessely(km1,z)-bessely(kp1,z))/2.0;
}

// Must flip sign for negative k and odd k.
if (k<0 && ((k % 2) != 0)) {
y = -y;
}

return y;
}

} // namespace xsf
} // namespace mathieu

#endif // #ifndef BESSELJYD_H
Loading
Loading