nu_cmd_extra/extra/math/
tanh.rs

1use nu_engine::command_prelude::*;
2
3#[derive(Clone)]
4pub struct MathTanH;
5
6impl Command for MathTanH {
7    fn name(&self) -> &str {
8        "math tanh"
9    }
10
11    fn signature(&self) -> Signature {
12        Signature::build("math tanh")
13            .input_output_types(vec![
14                (Type::Number, Type::Float),
15                (
16                    Type::List(Box::new(Type::Number)),
17                    Type::List(Box::new(Type::Float)),
18                ),
19            ])
20            .allow_variants_without_examples(true)
21            .category(Category::Math)
22    }
23
24    fn description(&self) -> &str {
25        "Returns the hyperbolic tangent of the number."
26    }
27
28    fn search_terms(&self) -> Vec<&str> {
29        vec!["trigonometry", "hyperbolic"]
30    }
31
32    fn run(
33        &self,
34        engine_state: &EngineState,
35        _stack: &mut Stack,
36        call: &Call,
37        input: PipelineData,
38    ) -> Result<PipelineData, ShellError> {
39        let head = call.head;
40        // This doesn't match explicit nulls
41        if let PipelineData::Empty = input {
42            return Err(ShellError::PipelineEmpty { dst_span: head });
43        }
44        input.map(move |value| operate(value, head), engine_state.signals())
45    }
46
47    fn examples(&self) -> Vec<Example<'_>> {
48        vec![Example {
49            description: "Apply the hyperbolic tangent to 10*π",
50            example: "3.141592 * 10 | math tanh | math round --precision 4",
51            result: Some(Value::test_float(1f64)),
52        }]
53    }
54}
55
56fn operate(value: Value, head: Span) -> Value {
57    match value {
58        numeric @ (Value::Int { .. } | Value::Float { .. }) => {
59            let span = numeric.span();
60            let (val, span) = match numeric {
61                Value::Int { val, .. } => (val as f64, span),
62                Value::Float { val, .. } => (val, span),
63                _ => unreachable!(),
64            };
65
66            Value::float(val.tanh(), span)
67        }
68        Value::Error { .. } => value,
69        other => Value::error(
70            ShellError::OnlySupportsThisInputType {
71                exp_input_type: "numeric".into(),
72                wrong_type: other.get_type().to_string(),
73                dst_span: head,
74                src_span: other.span(),
75            },
76            head,
77        ),
78    }
79}
80
81#[cfg(test)]
82mod test {
83    use super::*;
84
85    #[test]
86    fn test_examples() {
87        use crate::test_examples;
88
89        test_examples(MathTanH {})
90    }
91}
nu_cmd_extra/extra/math/tanh.rs

nu_cmd_extra/extra/math/
tanh.rs
