docs: update all readmes

thi-ng · Jan 3, 2020 · 44bcbdc · 44bcbdc
1 parent 228a81e
commit 44bcbdc
Show file tree

Hide file tree

Showing 112 changed files with 276 additions and 164 deletions.
diff --git a/packages/adjacency/README.md b/packages/adjacency/README.md
@@ -69,4 +69,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2018 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2018 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/api/README.md b/packages/api/README.md
@@ -71,4 +71,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/arrays/README.md b/packages/arrays/README.md
@@ -94,4 +94,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2018 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2018 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/associative/README.md b/packages/associative/README.md
@@ -310,4 +310,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2017 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2017 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/atom/README.md b/packages/atom/README.md
@@ -530,4 +530,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/bench/README.md b/packages/bench/README.md
@@ -136,4 +136,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2018 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2018 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/bencode/README.md b/packages/bencode/README.md
@@ -104,4 +104,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/binary/README.md b/packages/binary/README.md
@@ -62,4 +62,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/bitfield/README.md b/packages/bitfield/README.md
@@ -93,4 +93,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/bitstream/README.md b/packages/bitstream/README.md
@@ -143,4 +143,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/cache/README.md b/packages/cache/README.md
@@ -216,4 +216,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2018 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2018 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/checks/README.md b/packages/checks/README.md
@@ -56,4 +56,4 @@ TODO
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/compare/README.md b/packages/compare/README.md
@@ -79,4 +79,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/compose/README.md b/packages/compose/README.md
@@ -54,4 +54,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/csp/README.md b/packages/csp/README.md
@@ -231,4 +231,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/dcons/README.md b/packages/dcons/README.md
@@ -126,4 +126,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2017 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2017 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/defmulti/README.md b/packages/defmulti/README.md
@@ -320,4 +320,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2018 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2018 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/dgraph/README.md b/packages/dgraph/README.md
@@ -91,4 +91,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2015 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2015 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/diff/README.md b/packages/diff/README.md
@@ -75,4 +75,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/dlogic/README.md b/packages/dlogic/README.md
@@ -71,4 +71,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2017 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2017 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/dot/README.md b/packages/dot/README.md
@@ -145,4 +145,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2018 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2018 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/dsp/README.md b/packages/dsp/README.md
@@ -15,12 +15,17 @@ This project is part of the
 - [Dependencies](#dependencies)
 - [Usage examples](#usage-examples)
 - [API](#api)
+  - [Oscillators](#oscillators)
+  - [LFO](#lfo)
+  - [DelayLine](#delayline)
+  - [FFT](#fft)
+  - [Window functions](#window-functions)
 - [Authors](#authors)
 - [License](#license)
 
 ## About
 
-Assorted oscillators / waveform generators & DSP utils.
+Assorted oscillators / wave gens, FFT, windowing functions & DSP utils.
 
 Partially ported from other thi.ng projects (e.g.
 [thi.ng/synstack](https://github.com/thi-ng/synstack)). Currently only
@@ -42,6 +47,7 @@ yarn add @thi.ng/dsp
 ## Dependencies
 
 - [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/master/packages/api)
+- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/master/packages/checks)
 - [@thi.ng/math](https://github.com/thi-ng/umbrella/tree/master/packages/math)
 
 ## Usage examples
@@ -52,6 +58,14 @@ directory are using this package.
 
 A selection:
 
+### fft-synth <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/fft-synth.png)
+
+Interactive inverse FFT toy synth
+
+[Live demo](https://demo.thi.ng/umbrella/fft-synth/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/fft-synth)
+
 ### poly-spline <!-- NOTOC -->
 
 [Live demo](https://demo.thi.ng/umbrella/poly-spline/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/poly-spline)
@@ -66,37 +80,74 @@ A selection:
 
 [Generated API docs](https://docs.thi.ng/umbrella/dsp/)
 
-```ts
-import * as dsp from "@thi.ng/dsp";
-import { take } from "@thi.ng/transducers";
-
-[...take(20, new dsp.Oscillator(dsp.mix(dsp.sin, dsp.rect), 1/20)]
-// [ 0.5,
-//   0.6545084971874737,
-//   0.7938926261462366,
-//   0.9045084971874737,
-//   0.9755282581475768,
-//   1,
-//   0.9755282581475768,
-//   0.9045084971874737,
-//   0.7938926261462367,
-//   0.654508497187474,
-//   0.5000000000000003,
-//   -0.6545084971874735,
-//   -0.7938926261462365,
-//   -0.9045084971874737,
-//   -0.9755282581475768,
-//   -1,
-//   -0.9755282581475766,
-//   -0.9045084971874735,
-//   -0.793892626146236,
-//   -0.6545084971874731 ]
-```
+### Oscillators
+
+[Source](https://github.com/thi-ng/umbrella/blob/master/packages/dsp/src/osc.ts)
+
+Stateless & not band-limited:
+
+- sin()
+- tri()
+- triConcave()
+- rect()
+- saw()
+- wavetable()
+- mix()
+- additive() (bandlimited)
+- squareAdditive()
+- sawAdditive()
+
+Stateful:
+
+- Oscillator
+- AMFMOscillator
+
+### LFO
+
+Trigonometry free sin/cos oscillator / iterator based on a state-variable filter. Only useable for freq < ~2Hz.
+
+- lfo()
+
+### DelayLine
+
+Ringbuffer / delay line for arbitrary values and support for tapping at any relative position.
+
+- DelayLine
+
+### FFT
+
+- fft()
+- ifft()
+- normalizeFFT()
+- denormalizeFFT()
+- scaleFFT()
+- conjugate()
+- spectrumMag()
+- spectrumPow() (optionally as dBFS)
+- spectrumPhase()
+- binFreq()
+- freqBin()
+- fftFreq()
+
+### Window functions
+
+- window()
+- windowRect()
+- windowSin()
+- windowSinPow()
+- windowLanczos()
+- windowHann()
+- windowHamming()
+- windowBlackman()
+- windowBlackmanHarris()
+- windowNuttal()
+- windowBlackmanNuttal()
+- windowGauss()
 
 ## Authors
 
 Karsten Schmidt
 
 ## License
 
-&copy; 2015 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2015 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/dsp/README.tpl.md b/packages/dsp/README.tpl.md
@@ -44,32 +44,69 @@ ${examples}
 
 ${docLink}
 
-```ts
-import * as dsp from "@thi.ng/dsp";
-import { take } from "@thi.ng/transducers";
-
-[...take(20, new dsp.Oscillator(dsp.mix(dsp.sin, dsp.rect), 1/20)]
-// [ 0.5,
-//   0.6545084971874737,
-//   0.7938926261462366,
-//   0.9045084971874737,
-//   0.9755282581475768,
-//   1,
-//   0.9755282581475768,
-//   0.9045084971874737,
-//   0.7938926261462367,
-//   0.654508497187474,
-//   0.5000000000000003,
-//   -0.6545084971874735,
-//   -0.7938926261462365,
-//   -0.9045084971874737,
-//   -0.9755282581475768,
-//   -1,
-//   -0.9755282581475766,
-//   -0.9045084971874735,
-//   -0.793892626146236,
-//   -0.6545084971874731 ]
-```
+### Oscillators
+
+[Source](https://github.com/thi-ng/umbrella/blob/master/packages/dsp/src/osc.ts)
+
+Stateless & not band-limited:
+
+- sin()
+- tri()
+- triConcave()
+- rect()
+- saw()
+- wavetable()
+- mix()
+- additive() (bandlimited)
+- squareAdditive()
+- sawAdditive()
+
+Stateful:
+
+- Oscillator
+- AMFMOscillator
+
+### LFO
+
+Trigonometry free sin/cos oscillator / iterator based on a state-variable filter. Only useable for freq < ~2Hz.
+
+- lfo()
+
+### DelayLine
+
+Ringbuffer / delay line for arbitrary values and support for tapping at any relative position.
+
+- DelayLine
+
+### FFT
+
+- fft()
+- ifft()
+- normalizeFFT()
+- denormalizeFFT()
+- scaleFFT()
+- conjugate()
+- spectrumMag()
+- spectrumPow() (optionally as dBFS)
+- spectrumPhase()
+- binFreq()
+- freqBin()
+- fftFreq()
+
+### Window functions
+
+- window()
+- windowRect()
+- windowSin()
+- windowSinPow()
+- windowLanczos()
+- windowHann()
+- windowHamming()
+- windowBlackman()
+- windowBlackmanHarris()
+- windowNuttal()
+- windowBlackmanNuttal()
+- windowGauss()
 
 ## Authors
 

diff --git a/packages/ecs/README.md b/packages/ecs/README.md
@@ -146,4 +146,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2019 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/equiv/README.md b/packages/equiv/README.md
@@ -101,4 +101,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/errors/README.md b/packages/errors/README.md
@@ -79,4 +79,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2018 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2018 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/fsm/README.md b/packages/fsm/README.md
@@ -127,4 +127,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2018 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2018 - 2020 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/geom-accel/README.md b/packages/geom-accel/README.md
@@ -92,4 +92,4 @@ Karsten Schmidt
 
 ## License
 
-&copy; 2013 - 2019 Karsten Schmidt // Apache Software License 2.0
+&copy; 2013 - 2020 Karsten Schmidt // Apache Software License 2.0