Skip to main content

gananayantra/
lib.rs

1//! # gananayantra
2//!
3//! **gananayantra** is a professional-grade, multi-industry calculation engine written in Rust.
4//! It provides reusable, library-first calculators across diverse domains including:
5//!
6//! - **Finance**: ROI, time value of money, compound interest, loans, taxes, retirement
7//! - **Health**: BMI, BMR, body fat percentage, pregnancy, fitness
8//! - **Energy**: Power consumption, electricity cost
9//! - **Geo**: Earth distance (Haversine), horizon distance
10//! - **Water**: Pressure at depth, river flow rate
11//! - **Space**: Orbital velocity, escape velocity, orbital period
12//! - **Math**: Statistics, geometry, advanced math
13//! - **Logistics**: Freight weights, inventory (EOQ)
14//! - **Physics**: Fluid dynamics, kinematics
15//! - **Climate**: Carbon footprint
16//! - **Utilities**: Percentage calculations, lifestyle tools
17//! - **Specialized**: Building, electronics, networking, science
18//!
19//! ## Design Principles
20//!
21//! This crate is **library-first** and does not impose any CLI or I/O model.
22//! All public functions:
23//! - Accept typed parameters
24//! - Return `Result<T, String>` for safe error handling (usually `Result<f64, String>`)
25//! - Perform input validation
26//! - Are pure functions with no side effects
27//!
28//! ## Quick Start
29//!
30//! ```rust
31//! use gananayantra::finance::tvm::future_value;
32//!
33//! let fv = future_value(10_000.0, 0.08, 5).unwrap();
34//! assert!(fv > 14_000.0);
35//! ```
36
37pub mod climate;
38pub mod energy;
39pub mod finance;
40pub mod finance_investment;
41pub mod geo;
42pub mod health;
43pub mod logistics;
44pub mod math;
45pub mod physics;
46pub mod space;
47pub mod specialized;
48pub mod utilities;
49pub mod utility_lifestyle;
50pub mod water;