initial commit

Author: tspooner

.codeclimate.yml

@@ -0,0 +1,14 @@
+engines:
+  fixme:
+    enabled: true
+
+ratings:
+  paths:
+  - src/**
+  - examples/**
+
+exclude_paths:
+  - target/
+  - extern/
+  - Cargo.*
+  - rustfmt.toml

.gitignore

@@ -0,0 +1,13 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here http://doc.crates.io/guide.html#cargotoml-vs-cargolock
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# This is a debugging file used for development
+examples/sandbox.rs

.travis.yml

@@ -0,0 +1,47 @@
+language: rust
+dist: trusty
+sudo: false
+
+addons:
+  apt:
+    packages:
+      - libcurl4-openssl-dev
+      - libelf-dev
+      - libdw-dev
+      - binutils-dev
+      - gfortran
+      - libopenblas-dev
+      - cmake
+    sources:
+      - kalakris-cmake
+
+rust:
+  - stable
+
+before_script:
+  - |
+      cargo install cargo-travis &&
+      export PATH=$HOME/.cargo/bin:$PATH
+
+script:
+  - |
+      cargo build &&
+      cargo test #&&
+      # cargo bench &&
+      # cargo --only stable doc
+
+after_success:
+  - cargo coveralls
+  - |
+      [ $TRAVIS_BRANCH = master ] &&
+      [ $TRAVIS_PULL_REQUEST = false ] &&
+      cargo doc --no-deps &&
+      echo "<meta http-equiv=refresh content=0;url=`echo $TRAVIS_REPO_SLUG | cut -d '/' -f 2`/index.html>" > target/doc/index.html &&
+      pip install --user ghp-import &&
+      /home/travis/.local/bin/ghp-import -n target/doc &&
+      git push -fq https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages
+
+env:
+  global:
+      - TRAVIS_CARGO_NIGHTLY_FEATURE=""
+      - secure: AcBwzPJGszAqn4hW891+ZzbcxVA5wETXUmBg61cGKegHhFKBssB7HaNTcVX1pL3lHUiNGiLKReM+xbMPbth9c3ttz1SKlVsDJbQzt/lNaOjMmdkXd/0PNC7ZWT3yXx8sIbuyz2XCL6TW3dkvYt3G2+Ioy0BxeRepEbfhm1NEMWHoQXbLVkFiH4XtpfADY4DENWiuUbVA3/8+Qwc9R7i4mIf7J8EQWc1+HcNhuy556FrmkkAIDvRU2h0sl9HhjMrTHIKPalfXuriW4pQbZHH+JbA9Xh8MbX230PMqZaELxYkh020Fxy4z2z0VvISmLoMBFQb6JSh11AWQsFno1TZkVqhG2yl1tBPvdKgaqrBLZ8MsES8bG5i/LVDv2kM+dmbtWQmRmn6PnvBmJeJW5bbYx4F2PW57mDUebK/TKEF+1HbBR9KGm2fIihk46mvhxxpQ3ZE7A8lDs17Up9ZBhhYM5RJJ174Ls1Yn+qmtdhEAe5IJ4x5xRNYraTlKJHy2FCgqTeLEKB8TzDB0DUhaDMY6EnuOJdZFjEk5QSzSZJBKNSfyqO+N43vloWt3lszscekgQtYHATvDhylYFrIdRFPrqB3/BYIYOHEzZblTCSres8zmMBTfnWyAn37Z4y4fWsq3NUXcZkOd29HfjAi8qa7vVDQ4d1e1c0RCPOSKiCb7zP0=

Cargo.toml

@@ -0,0 +1,28 @@
+[package]
+name = "spaces"
+description = "Vector space primitives for machine learning problems."
+
+version = "0.0.1"
+authors = ["Tom Spooner <t.spooner@liverpool.ac.uk>"]
+
+license = "MIT"
+readme = "README.md"
+
+keywords = ["geometry", "vector", "spaces", "mahcine", "learning"]
+
+repository = "https://github.com/tspooner/spaces"
+documentation = "https://tspooner.github.io/spaces/spaces/index.html"
+
+[badges]
+travis-ci = { repository = "tspooner/spaces", branch = "master" }
+coveralls = { repository = "tspooner/spaces", branch = "master", service = "github" }
+
+[dependencies]
+rand = "0.4"
+ndarray = { version = "0.11", features = ["serde-1"] }
+rusty-machine = "0.5"
+
+serde = "1.0"
+serde_json = "1.0"
+serde_test = "1.0"
+serde_derive = "1.0"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Tom Spooner
+
+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.

README.md

@@ -0,0 +1,29 @@
+# spaces ([api](https://tspooner.github.io/spaces))
+
+[![Crates.io](https://img.shields.io/crates/v/spaces.svg)](https://crates.io/crates/spaces)
+[![Build Status](https://travis-ci.org/tspooner/spaces.svg?branch=master)](https://travis-ci.org/tspooner/spaces)
+[![Coverage Status](https://coveralls.io/repos/github/tspooner/spaces/badge.svg?branch=master)](https://coveralls.io/github/tspooner/spaces?branch=master)
+
+<!--
+## Overview
+
+
+## Installation
+```toml
+[dependencies]
+spaces = "0.0"
+```
+
+
+## Usage
+-->
+
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to
+discuss what you would like to change.
+
+Please make sure to update tests as appropriate and adhere to the angularjs commit message conventions (see [here](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)).
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)

rustfmt.toml

@@ -0,0 +1,2 @@
+format_strings = false
+reorder_imports = true

src/dimensions.rs

@@ -0,0 +1,28 @@
+extern crate rand;
+extern crate ndarray;
+
+extern crate serde;
+extern crate serde_json;
+extern crate serde_test;
+#[macro_use] extern crate serde_derive;
+
+
+mod macros;
+
+pub mod norms;
+
+mod span;
+pub use self::span::Span;
+
+/// 1d array type.
+pub type Vector<T = f64> = ndarray::Array1<T>;
+
+/// 2d array type.
+pub type Matrix<T = f64> = ndarray::Array2<T>;
+
+mod spaces;
+pub mod dimensions;
+pub use self::spaces::*;
+
+extern crate rusty_machine;
+pub use self::rusty_machine::learning::toolkit::kernel as kernels;

src/lib.rs

@@ -0,0 +1,28 @@
+#![macro_use]
+
+macro_rules! wrap {
+    ($lb:expr, $x:expr, $ub:expr) => {
+        {
+            let mut nx = $x;
+            let diff = $ub - $lb;
+
+            while nx > $ub {
+                nx -= diff;
+            }
+
+            while nx < $lb {
+                nx += diff;
+            }
+
+            nx
+        }
+    }
+}
+
+macro_rules! clip {
+    ($lb:expr, $x:expr, $ub:expr) => {
+        {
+            $lb.max($ub.min($x))
+        }
+    }
+}

src/macros.rs

@@ -0,0 +1,33 @@
+//! Normalisation utilities module.
+
+/// Computes the L1 norm.
+#[inline]
+pub fn l1(x: &[f64]) -> f64 {
+    x.iter().fold(0.0, |acc, v| acc + v.abs())
+}
+
+/// Computes the L2 norm.
+#[inline]
+pub fn l2(x: &[f64]) -> f64 {
+    x.iter().fold(0.0, |acc, v| acc + (v*v).abs()).sqrt()
+}
+
+/// Computes the Lp norm.
+#[inline]
+pub fn lp(x: &[f64], p: u8) -> f64 {
+    x.iter().fold(0.0, |acc, v| acc + v.abs().powi(p as i32)).powf((p as f64).recip())
+}
+
+/// Computes the infinity norm.
+#[inline]
+pub fn linf(x: &[f64]) -> f64 {
+    x.iter().fold(0.0, |max, v| {
+        let av = v.abs();
+
+        if av > max {
+            av
+        } else {
+            max
+        }
+    })
+}

src/norms.rs

@@ -0,0 +1,103 @@
+use std::ops::Mul;
+
+
+#[derive(Clone, Copy, Serialize, Deserialize, Debug, PartialEq, Eq)]
+pub enum Span {
+    Null,
+    Finite(usize),
+    Infinite,
+}
+
+impl Mul for Span {
+    type Output = Span;
+
+    fn mul(self, rhs: Span) -> Span {
+        match self {
+            Span::Null => rhs,
+            Span::Infinite => self,
+            Span::Finite(ls) => {
+                match rhs {
+                    Span::Null => self,
+                    Span::Infinite => rhs,
+                    Span::Finite(rs) => Span::Finite(ls * rs),
+                }
+            }
+        }
+    }
+}
+
+impl Into<usize> for Span {
+    fn into(self) -> usize {
+        match self {
+            Span::Finite(e) => e,
+            _ => panic!("Span type has no integer representation."),
+        }
+    }
+}
+
+
+#[cfg(test)]
+mod tests {
+    use super::Span;
+
+    #[test]
+    fn test_equality() {
+        assert_eq!(Span::Null, Span::Null);
+        assert_eq!(Span::Infinite, Span::Infinite);
+
+        assert_eq!(Span::Finite(1), Span::Finite(1));
+        assert_eq!(Span::Finite(5), Span::Finite(5));
+        assert_eq!(Span::Finite(10), Span::Finite(10));
+    }
+
+    #[test]
+    fn test_inequality() {
+        assert_ne!(Span::Null, Span::Infinite);
+        assert_ne!(Span::Null, Span::Finite(1));
+
+        assert_ne!(Span::Infinite, Span::Null);
+        assert_ne!(Span::Infinite, Span::Finite(1));
+
+        assert_ne!(Span::Finite(1), Span::Null);
+        assert_ne!(Span::Finite(1), Span::Infinite);
+        assert_ne!(Span::Finite(1), Span::Finite(10));
+    }
+
+    #[test]
+    fn test_mul() {
+        assert_eq!(Span::Null * Span::Null, Span::Null);
+        assert_eq!(Span::Infinite * Span::Infinite, Span::Infinite);
+
+        assert_eq!(Span::Null * Span::Infinite, Span::Infinite);
+        assert_eq!(Span::Infinite * Span::Null, Span::Infinite);
+
+        assert_eq!(Span::Finite(1) * Span::Finite(1), Span::Finite(1));
+        assert_eq!(Span::Finite(1) * Span::Finite(5), Span::Finite(5));
+        assert_eq!(Span::Finite(5) * Span::Finite(1), Span::Finite(5));
+        assert_eq!(Span::Finite(5) * Span::Finite(5), Span::Finite(25));
+    }
+
+    #[test]
+    #[should_panic]
+    fn test_into_null() {
+        let s = Span::Null;
+        let _: usize = s.into();
+    }
+
+    #[test]
+    #[should_panic]
+    fn test_into_infinite() {
+        let s = Span::Infinite;
+        let _: usize = s.into();
+    }
+
+    #[test]
+    fn test_into_finite() {
+        for i in vec![1, 5, 10] {
+            let d = Span::Finite(i);
+            let v: usize = d.into();
+
+            assert_eq!(v, i);
+        }
+    }
+}