Merge pull request #153 from Chris00/master

Initial work on a `Vector` trait

.github/workflows/CI.yml

@@ -8,16 +8,14 @@ name: CI
 jobs:
   build-linux:
     runs-on: ubuntu-latest
-    container:
-      image: ubuntu:23.10
     strategy:
       matrix:
         rust:
           - stable
           - nightly
     steps:
-      - run: apt-get update -y
-      - run: apt-get install -y libgsl0-dev curl build-essential python3
+      - run: sudo apt-get update -y
+      - run: sudo apt-get install -y libgsl0-dev curl build-essential python3
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
@@ -36,10 +34,8 @@ jobs:
       - name: run tests
         run: cargo test --features v2_7
       - name: check examples
-        working-directory: examples
-        run: cargo check --features GSL/v2_7
+        run: cargo check --features v2_7
       - name: run examples
-        working-directory: examples
         run: python3 run-examples.py
 
   build-osx:
@@ -67,7 +63,7 @@ jobs:
       - run: cargo check --features v2_7
       - name: check examples
         working-directory: examples
-        run: cargo check --features GSL/v2_7
+        run: cargo check --features v2_7
 
   fmt:
     name: rust fmt

Cargo.toml

@@ -13,8 +13,10 @@ edition = "2021"
 [dependencies]
 sys = { path = "gsl-sys", package = "GSL-sys", version = "3.0.0" }
 paste = "1.0"
+num-complex = { version = "0.4.6", optional = true }
 
 [features]
+default = ["complex"]
 v2_1 = ["sys/v2_1"]
 v2_2 = ["sys/v2_2", "v2_1"]
 v2_3 = ["sys/v2_3", "v2_2"]
@@ -23,6 +25,8 @@ v2_5 = ["sys/v2_5", "v2_4"]
 v2_6 = ["sys/v2_6", "v2_5"]
 v2_7 = ["sys/v2_7", "v2_6"]
 dox = ["v2_7", "sys/dox"]
+# Enable complex number functions:
+complex = ["dep:num-complex"]
 
 [package.metadata.docs.rs]
 features = ["dox"]
@@ -31,3 +35,36 @@ rustdoc-args = ["--generate-link-to-definition"]
 [lib]
 name = "rgsl"
 crate-type = ["dylib", "rlib"]
+
+# Examples with special requirements
+[[example]]
+name = "filt_edge"
+required-features = ["v2_5"]
+
+[[example]]
+name = "fitreg"
+required-features = ["v2_5"]
+
+[[example]]
+name = "fitreg2"
+required-features = ["v2_5"]
+
+[[example]]
+name = "fitting"
+required-features = ["v2_5"]
+
+[[example]]
+name = "gaussfilt"
+required-features = ["v2_5"]
+
+[[example]]
+name = "gaussfilt2"
+required-features = ["v2_5"]
+
+[[example]]
+name = "impulse"
+required-features = ["v2_5"]
+
+[[example]]
+name = "largefit"
+required-features = ["v2_2"]

examples/README.md

@@ -3,7 +3,7 @@
 This folder contains the `rgsl` examples. To run one, just use `cargo`:
 
 ```bash
-$ cargo run --bin intro
+$ cargo run --example intro
 ```
 
 And that's it!
@@ -12,7 +12,7 @@ Some examples might require a higher GSL version. `rgsl` supports versions throu
 So for example:
 
 ```bash
-$ cargo run --bin largefit --features GSL/v2_2
+$ cargo run --example largefit --features v2_2
 ```
 
 # Original examples

examples/bspline.rs

@@ -64,12 +64,7 @@ fn main() {
     let chisq = mw.wlinear(&mat_x, &w, &y, &mut c, &mut cov).unwrap();
 
     let dof = N - NCOEFFS;
-    let tss = stats::wtss(
-        w.as_slice().expect("as_slice failed"),
-        1,
-        y.as_slice().expect("as_slice failed"),
-        1,
-    );
+    let tss = stats::wtss(&w, &y);
     let rsq = 1. - chisq / tss;
 
     eprintln!("chisq/dof = {}, rsq = {}", chisq / dof as f64, rsq);

examples/eigen_nonsymm.rs

@@ -29,13 +29,13 @@ fn main() {
     for i in 0..4 {
         let eval_i = eval.get(i);
         evec.column(i, |evec_i| {
-            println!("eigenvalue = {} + {}", eval_i.real(), eval_i.imaginary());
+            println!("eigenvalue = {eval_i}");
             evec_i.expect("Failed to get get column").vector(|v| {
                 let v = v.expect("Failed to get vector from column");
                 println!("eigenvector = ");
                 for j in 0..4 {
                     let z = v.get(j);
-                    println!("{} + {}", z.real(), z.imaginary());
+                    println!("{z}");
                 }
             });
         });

examples/fft.rs

@@ -2,47 +2,30 @@
 // A rust binding for the GSL library by Guillaume Gomez ([email protected])
 //
 
-extern crate rgsl;
-
+use num_complex::c64;
 use rgsl::fft;
 
-macro_rules! real {
-    ($z:ident, $i:expr) => {
-        $z[2 * ($i)]
-    };
-}
-macro_rules! imag {
-    ($z:ident, $i:expr) => {
-        $z[2 * ($i) + 1]
-    };
-}
-
 const N: usize = 128;
 
 fn main() {
-    let data = &mut [0.; 2 * N];
+    let data = &mut [c64(0., 0.); N];
 
-    real!(data, 0) = 1.;
+    data[0].re = 1.;
 
     for i in 1..=10 {
-        real!(data, i) = 1.;
-        real!(data, N - i) = 1.;
+        data[i].re = 1.;
+        data[N - i].re = 1.;
     }
 
     for i in 0..N {
-        println!("{} {} {}", i, real!(data, i), imag!(data, i));
+        println!("{} {}", i, data[i]);
     }
     println!();
     println!();
 
-    fft::radix2::forward(data, 1, N).unwrap();
+    fft::radix2::forward(data).unwrap();
 
     for i in 0..N {
-        println!(
-            "{} {} {}",
-            i,
-            real!(data, i) / 128f64.sqrt(),
-            imag!(data, i) / 128f64.sqrt()
-        );
+        println!("{} {}", i, data[i] / 128f64.sqrt());
     }
 }

examples/fftmr.rs

@@ -4,45 +4,35 @@
 
 extern crate rgsl;
 
+use num_complex::c64;
 use rgsl::{FftComplexF64WaveTable, FftComplexF64Workspace};
 
-macro_rules! real {
-    ($z:ident, $i:expr) => {
-        $z[2 * ($i)]
-    };
-}
-macro_rules! imag {
-    ($z:ident, $i:expr) => {
-        $z[2 * ($i) + 1]
-    };
-}
-
-const N: usize = 630;
+const N: usize = 128;
 
 fn main() {
-    let data = &mut [0.; 2 * N];
+    let data = &mut [c64(0., 0.); N];
     let wavetable = FftComplexF64WaveTable::new(N).expect("FftComplexF64WaveTable::new failed");
     let mut workspace = FftComplexF64Workspace::new(N).expect("FftComplexF64Workspace::new failed");
 
-    data[0] = 1.;
+    data[0].re = 1.;
 
     for i in 1..=10 {
-        real!(data, i) = 1.;
-        real!(data, N - i) = 1.;
+        data[i].re = 1.;
+        data[N - i].re = 1.;
     }
 
     for i in 0..N {
-        println!("{}: {} {}", i, real!(data, i), imag!(data, i));
+        println!("{}: {}", i, data[i]);
     }
     println!();
 
     for i in 0..wavetable.nf() {
         println!("# factor {}: {}", i, wavetable.factor()[i]);
     }
 
-    workspace.forward(data, 1, N, &wavetable).unwrap();
+    workspace.forward(data, &wavetable).unwrap();
 
     for i in 0..N {
-        println!("{}: {} {}", i, real!(data, i), imag!(data, i));
+        println!("{}: {}", i, data[i]);
     }
 }