First commit

.github/workflows/build.yml

@@ -0,0 +1,13 @@
+name: build
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+    - run: cargo test

.gitignore

@@ -0,0 +1,2 @@
+/target
+Cargo.lock

CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2021-10-15)
+
+- First release

Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "stlrs"
+version = "0.1.0"
+description = "Seasonal-trend decomposition for Rust"
+repository = "https://github.com/ankane/stl-rust"
+license = "Unlicense OR MIT"
+authors = ["Andrew Kane <andrew@ankane.org>"]
+edition = "2018"
+readme = "README.md"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

LICENSE-MIT

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Contributors
+
+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,99 @@
+# STL Rust
+
+Seasonal-trend decomposition for Rust
+
+[![Build Status](https://github.com/ankane/stl-rust/workflows/build/badge.svg?branch=master)](https://github.com/ankane/stl-rust/actions)
+
+## Installation
+
+Add this line to your application’s `Cargo.toml` under `[dependencies]`:
+
+```toml
+stlrs = "0.1"
+```
+
+## Getting Started
+
+Decompose a time series
+
+```rust
+let series = vec![
+    5.0, 9.0, 2.0, 9.0, 0.0, 6.0, 3.0, 8.0, 5.0, 8.0,
+    7.0, 8.0, 8.0, 0.0, 2.0, 5.0, 0.0, 5.0, 6.0, 7.0,
+    3.0, 6.0, 1.0, 4.0, 4.0, 4.0, 3.0, 7.0, 5.0, 8.0
+];
+let period = 7; // period of the seasonal component
+
+let res = stlrs::params().fit(&series, period);
+```
+
+Get the components
+
+```rust
+res.seasonal();
+res.trend();
+res.remainder();
+```
+
+## Robustness
+
+Use robustness iterations
+
+```rust
+let res = stlrs::params().robust(true).fit(&series, period);
+```
+
+Get robustness weights
+
+```rust
+res.weights();
+```
+
+## Parameters
+
+Set parameters
+
+```rust
+stlrs::params()
+    .seasonal_length(7)     // length of the seasonal smoother
+    .trend_length(15)       // length of the trend smoother
+    .low_pass_length(7)     // length of the low-pass filter
+    .seasonal_degree(0)     // degree of locally-fitted polynomial in seasonal smoothing
+    .trend_degree(1)        // degree of locally-fitted polynomial in trend smoothing
+    .low_pass_degree(1)     // degree of locally-fitted polynomial in low-pass smoothing
+    .seasonal_jump(1)       // skipping value for seasonal smoothing
+    .trend_jump(2)          // skipping value for trend smoothing
+    .low_pass_jump(1)       // skipping value for low-pass smoothing
+    .inner_loops(2)         // number of loops for updating the seasonal and trend components
+    .outer_loops(0)         // number of iterations of robust fitting
+    .robust(false)          // if robustness iterations are to be used
+```
+
+## Credits
+
+This library was ported from the [Fortran implementation](https://www.netlib.org/a/stl).
+
+## References
+
+- [STL: A Seasonal-Trend Decomposition Procedure Based on Loess](https://www.scb.se/contentassets/ca21efb41fee47d293bbee5bf7be7fb3/stl-a-seasonal-trend-decomposition-procedure-based-on-loess.pdf)
+
+## History
+
+View the [changelog](https://github.com/ankane/stl-rust/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/stl-rust/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/stl-rust/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/stl-rust.git
+cd stl-rust
+cargo test
+```

UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>