https://github.com/shakfu/pd-gsl
puredata external which wraps a subset of the gnu scientific library (gsl)
https://github.com/shakfu/pd-gsl
c gsl puredata
Last synced: 7 months ago
JSON representation
puredata external which wraps a subset of the gnu scientific library (gsl)
- Host: GitHub
- URL: https://github.com/shakfu/pd-gsl
- Owner: shakfu
- License: unlicense
- Created: 2021-12-27T00:19:09.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-22T00:02:19.000Z (over 3 years ago)
- Last Synced: 2025-01-12T16:12:02.752Z (9 months ago)
- Topics: c, gsl, puredata
- Language: C
- Homepage:
- Size: 1.61 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# puredata scientific library (psl)
## Summary
Wraps some [gsl](https://www.gnu.org/software/gsl/) functions for puredata as
we as the [tinyexpr](https://github.com/codeplea/tinyexpr) library for
expression parsing.
Dev-Note: using the name `psl` instead of `gsl` for namespace prefixing of code to prevent namespace collisions (which would have occurred otherwise).
## Rationale
- Make some `gsl` functions accessible to puredata.
- See how far this can be done.
- Learn something new along the way.
## Usage
The external is a single statically linked puredata external with the name `[psl]` or `[gsl]` and which has a single inlet and a single outlet.
### Without Arguments
Basic usage is without arguments, where the object is sent messages to obtain a calculation:
```
[ .. (
```
In this case, `` is an abbreviated name of a `gsl` function following by its arguments. The result of the calculation is sent out the outlet.
The result can be a single float value or a list of floats depending on the function.
### With Function Name
Another usage variation is to include the name of a function as an argument during object creation, such as `[gsl bessel_j0]`. In this case, the following options apply:
- The # of inlets grow to the number of arguments so you can feed them directly with floatss via the number object.
- The function can be be fed arguments using a `list` message to the leftmost inlet with a length equal to its number of arguments:
```
[1.5 2.1 3.2(
```
Please see the file `help-psl.pd` for examples.
## To build
```
make
```
Note that the the static libraries included in this project are currently MACOS only. This is a development conveniance during the early stage of this project and not required per se. To make it work with other platforms just use the platform specific static libs instead.
## Development
Because quite a bit of the mapping work from `gsl` to `pd` external is quite repetitive, I have resorted to code-generation via a python script to make it more manageable.
This python3 script is in the `scripts` directory and has a dependency on the [mako](https://www.makotemplates.org) template library which is found to be quite suitable for code generation. The python3 `render.py` script uses a single `mako` template, `scripts/psl.c.mako`, and generates `psl.c` file directly in the project directory.
Effectively, this means that current development entails that changes are made to `scripts/psl.c.mako` rather than the generated `psl.c` file as per the following dev cycle:
1. modify `scripts/psl.c.mako`
2. run `scripts/render.py` to generate `psl.c`
3. make
typically running the following with each change:
```
./script/render.py && make
```
## TODO
- [ ] more functions!!
- [x] inlets-on-demand: proxy inlets to have the number of inlets dynamically grow with as per the selected functions (and its number of arguments).
- [ ] checkout [exprtk](http://www.partow.net/programming/exprtk/)