Struct Function

pub struct Function { /* private fields */ }

Parsed complex-valued function of a single variable.

A Function instance can be created using FromStr trait. A function must use z as the (only) argument. A function may use arithmetic operations (+, -, *, /, ^) and/or predefined unary functions:

• General functions: arg, sqrt, exp, log
• Hyperbolic trigonometry: sinh, cosh, tanh
• Inverse hyperbolic trigonometry: asinh, acosh, atanh

A function may define local variable assignment(s). The assignment syntax is similar to Python (or Rust, just without the let keyword): variable name followed by = and then by the arithmetic expression. Assignments must be separated by semicolons ;. As in Rust, the last expression in function body is its return value.

Examples

let function: Function = "z * z - 0.5".parse()?;
let fn_with_calls: Function = "0.8 * z + z / atanh(z ^ -4)".parse()?;
let fn_with_vars: Function = "c = -0.5 + 0.4i; z * z + c".parse()?;

Trait Implementations

impl Backend<&Function> for Cpu

type Error = Infallible

Error that may be returned during program creation.

type Program = CpuProgram<Function>

Program output by the backend.

fn create_program( &self, function: &Function, ) -> Result<Self::Program, Self::Error>

Creates a program.

impl Backend<&Function> for OpenCl

type Error = Error

Error that may be returned during program creation.

type Program = OpenClProgram

Program output by the backend.

fn create_program( &self, function: &Function, ) -> Result<Self::Program, Self::Error>

Creates a program.

impl Backend<&Function> for Vulkan

type Error = Error

Error that may be returned during program creation.

type Program = VulkanProgram

Program output by the backend.

fn create_program( &self, function: &Function, ) -> Result<Self::Program, Self::Error>

Creates a program.

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComputePoint for Function

fn compute_point(&self, z: Complex32) -> Complex32

Available on crate feature cpu_backend only.

Computes the function value at the specified point.

impl Debug for Function

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for Function

type Err = FnError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.