nu_cmd_extra/extra/math/
cosh.rs

1use nu_engine::command_prelude::*;
2
3#[derive(Clone)]
4pub struct MathCosH;
5
6impl Command for MathCosH {
7    fn name(&self) -> &str {
8        "math cosh"
9    }
10
11    fn signature(&self) -> Signature {
12        Signature::build("math cosh")
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 cosine 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        let e = std::f64::consts::E;
49        vec![Example {
50            description: "Apply the hyperbolic cosine to 1",
51            example: "1 | math cosh",
52            result: Some(Value::test_float(((e * e) + 1.0) / (2.0 * e))),
53        }]
54    }
55}
56
57fn operate(value: Value, head: Span) -> Value {
58    match value {
59        numeric @ (Value::Int { .. } | Value::Float { .. }) => {
60            let span = numeric.span();
61
62            let (val, span) = match numeric {
63                Value::Int { val, .. } => (val as f64, span),
64                Value::Float { val, .. } => (val, span),
65                _ => unreachable!(),
66            };
67
68            Value::float(val.cosh(), span)
69        }
70        Value::Error { .. } => value,
71        other => Value::error(
72            ShellError::OnlySupportsThisInputType {
73                exp_input_type: "numeric".into(),
74                wrong_type: other.get_type().to_string(),
75                dst_span: head,
76                src_span: other.span(),
77            },
78            head,
79        ),
80    }
81}
82
83#[cfg(test)]
84mod test {
85    use super::*;
86
87    #[test]
88    fn test_examples() {
89        use crate::test_examples;
90
91        test_examples(MathCosH {})
92    }
93}
nu_cmd_extra/extra/math/cosh.rs

nu_cmd_extra/extra/math/
cosh.rs
