use-oscillation 0.0.1

Oscillation and simple harmonic motion helpers for RustUse
Documentation
  • Coverage
  • 89.09%
    49 out of 55 items documented10 out of 49 items with examples
  • Size
  • Source code size: 28.45 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 662.52 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 5s Average build duration of successful builds.
  • all releases: 5s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • RustUse/use-physics
    1 0 0
  • crates.io
  • Dependencies
    • —
  • Versions
  • Owners
  • CloudBranch

use-oscillation

Oscillation and simple harmonic motion helpers for RustUse.

Install

[dependencies]
use-oscillation = "0.0.1"

Foundation

use-oscillation provides small scalar helpers for simple harmonic motion, period, frequency, angular frequency, spring oscillators, pendulum approximations, damping, resonance, and oscillator state summaries.

Inputs are expected to be SI-style numeric values:

  • seconds for period and time
  • hertz for frequency
  • radians per second for angular frequency
  • meters for displacement, amplitude, and pendulum length
  • kilograms for mass
  • newtons per meter for spring constant
  • meters per second squared for gravitational acceleration
  • joules for energy

Radians are used for phase.

Example

use core::f64::consts::{PI, TAU};
use use_oscillation::{SimpleHarmonicOscillator, spring_period};

let oscillator = SimpleHarmonicOscillator::new(2.0, TAU, 0.0).unwrap();
let period = spring_period(8.0, 2.0).unwrap();

assert!((oscillator.displacement(0.0).unwrap() - 2.0).abs() < 1.0e-12);
assert!((period - PI).abs() < 1.0e-12);

When to use directly

Choose use-oscillation when you only need reusable scalar helpers for simple oscillators.

Scope

  • This crate stays f64-first and scalar-only.
  • It is not a wave library, signal-processing library, acoustics library, numerical simulator, or control-system package.
  • Wave abstractions belong in the top-level use-wave set.
  • Signal processing belongs in the top-level use-signal set.
  • Acoustics belongs in the top-level use-acoustics set.
  • Units belong in the top-level use-units set.

Status

use-oscillation is a pre-1.0 crate with a deliberately small API.