456e2a8ee3
# Description we talked about this before in some meetings so i thought, why not? the hope is that these constants do not require Rust code to be implemented and that this move will make the Rust source base a bit smaller 🤞 # User-Facing Changes mathematical constants (e, pi, tau, phi and gamma) are now in `std math` rather than `math` ## what can be done ```nushell > use std; $std.math > use std math; $math > use std *; $math ``` will all give ``` ╭───────┬────────────────────╮ │ GAMMA │ 0.5772156649015329 │ │ E │ 2.718281828459045 │ │ PI │ 3.141592653589793 │ │ TAU │ 6.283185307179586 │ │ PHI │ 1.618033988749895 │ ╰───────┴────────────────────╯ ``` and the following will work too ```nushell > use std math E; $E 2.718281828459045 ``` ```nushell > use std math *; $GAMMA 0.5772156649015329 ``` ## what can NOT be done looks like every export works fine now 😌 # Tests + Formatting # After Submitting
111 lines
3.0 KiB
Rust
111 lines
3.0 KiB
Rust
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{Category, Example, PipelineData, ShellError, Signature, Span, Type, Value};
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"math ln"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("math ln")
|
|
.input_output_types(vec![
|
|
(Type::Number, Type::Float),
|
|
(
|
|
Type::List(Box::new(Type::Number)),
|
|
Type::List(Box::new(Type::Float)),
|
|
),
|
|
])
|
|
.allow_variants_without_examples(true)
|
|
.category(Category::Math)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Returns the natural logarithm. Base: (math e)."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["natural", "logarithm", "inverse", "euler"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
// This doesn't match explicit nulls
|
|
if matches!(input, PipelineData::Empty) {
|
|
return Err(ShellError::PipelineEmpty { dst_span: head });
|
|
}
|
|
input.map(
|
|
move |value| operate(value, head),
|
|
engine_state.ctrlc.clone(),
|
|
)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Get the natural logarithm of e",
|
|
example: "2.7182818 | math ln | math round --precision 4",
|
|
result: Some(Value::test_float(1.0f64)),
|
|
}]
|
|
}
|
|
}
|
|
|
|
fn operate(value: Value, head: Span) -> Value {
|
|
match value {
|
|
numeric @ (Value::Int { .. } | Value::Float { .. }) => {
|
|
let span = numeric.span();
|
|
let (val, span) = match numeric {
|
|
Value::Int { val, .. } => (val as f64, span),
|
|
Value::Float { val, .. } => (val, span),
|
|
_ => unreachable!(),
|
|
};
|
|
|
|
if val > 0.0 {
|
|
let val = val.ln();
|
|
|
|
Value::float(val, span)
|
|
} else {
|
|
Value::error(
|
|
ShellError::UnsupportedInput(
|
|
"'ln' undefined for values outside the open interval (0, Inf).".into(),
|
|
"value originates from here".into(),
|
|
head,
|
|
span,
|
|
),
|
|
span,
|
|
)
|
|
}
|
|
}
|
|
Value::Error { .. } => value,
|
|
other => Value::error(
|
|
ShellError::OnlySupportsThisInputType {
|
|
exp_input_type: "numeric".into(),
|
|
wrong_type: other.get_type().to_string(),
|
|
dst_span: head,
|
|
src_span: other.span(),
|
|
},
|
|
head,
|
|
),
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
}
|