rustduino 0.2.0

A generic HAL implementation for Arduino Boards in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

// RustDuino : A generic HAL implementation for Arduino Boards in Rust
// Copyright (C) 2021 Devansh Kumar Jha, Indian Institute of Technology Kanpur
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>

/// Maps a number from one data type to the another data type in a uniform ratio scale.
/// # Arguments
/// * `val` - a u64, the value which is to be mapped to any other data type.
/// * `in_min` - a u64, the minimum value possible in the data type of `val`.
/// * `in_max` - a u64, the maximum value possible in the data type of `val`.
/// * `out_min` - a u64, the minimum value possible in the required data type for `val`.
/// * `out_max` - a u64, the maximum value possible in the required data type for `val`.
/// # Returns
/// * `a u64` - the final value of `val` in the required data type.
pub fn map(val: u64, in_min: u64, in_max: u64, out_min: u64, out_max: u64) -> u64 {
    (val - in_min) * (out_max - out_min) / (in_max - in_min) + out_min
}