Struct magnus::RComplex

pub struct RComplex(/* private fields */);

A Value pointer to a RComplex struct, Ruby’s internal representation of complex numbers.

See the ReprValue trait for additional methods available on this type.

Implementations

impl RComplex

pub fn from_value(val: Value) -> Option<Self>

Return Some(RComplex) if val is a RComplex, None otherwise.

Examples

use magnus::{eval, RComplex};

assert!(RComplex::from_value(eval("2+1i").unwrap()).is_some());
assert!(RComplex::from_value(eval("3").unwrap()).is_none());

pub fn new<T, U>(real: T, imag: U) -> RComplex

where T: Numeric, U: Numeric,

Create a new RComplex.

Examples

use magnus::{Integer, RComplex};

let complex = RComplex::new(Integer::from_i64(2), Integer::from_i64(1));
assert_eq!(complex.to_string(), "2+1i");

pub fn polar<T, U>(real: T, imag: U) -> Result<RComplex, Error>

where T: Numeric, U: Numeric,

Create a new RComplex using polar representation.

Examples

use magnus::{Integer, RComplex};

let complex = RComplex::polar(Integer::from_i64(2), Integer::from_i64(3)).unwrap();
assert_eq!(
    complex.to_string(),
    "-1.9799849932008908+0.2822400161197344i"
);

pub fn real<T>(self) -> Result<T, Error>

where T: TryConvert,

Returns the real part of self.

Examples

use magnus::{Integer, RComplex};

let complex = RComplex::new(Integer::from_i64(9), Integer::from_i64(-4));
assert_eq!(complex.real::<i64>().unwrap(), 9);

pub fn imag<T>(self) -> Result<T, Error>

where T: TryConvert,

Returns the imaginary part of self.

Examples

use magnus::{Integer, RComplex};

let complex = RComplex::new(Integer::from_i64(9), Integer::from_i64(-4));
assert_eq!(complex.imag::<i64>().unwrap(), -4);

pub fn conjugate(self) -> Self

Returns the complex conjugate.

Examples

use magnus::{Integer, RComplex};

let complex = RComplex::new(Integer::from_i64(1), Integer::from_i64(2));
assert_eq!(complex.conjugate().to_string(), "1-2i");

pub fn abs(self) -> f64

Returns the absolute (or the magnitude) of self.

Examples

use magnus::{Integer, RComplex};

let complex = RComplex::new(Integer::from_i64(3), Integer::from_i64(-4));
assert_eq!(complex.abs(), 5.0);

pub fn arg(self) -> f64

Returns the argument (or the angle) of the polar form of self.

Examples

use std::f64::consts::PI;

use magnus::{Float, Integer, RComplex};

let complex = RComplex::polar(Integer::from_i64(3), Float::from_f64(PI / 2.0)).unwrap();
assert_eq!(complex.arg(), 1.5707963267948966);

Trait Implementations

impl Clone for RComplex

fn clone(&self) -> RComplex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RComplex

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

Formats the value using the given formatter.

impl Display for RComplex

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

Formats the value using the given formatter.

impl IntoValue for RComplex

fn into_value_with(self, _: &Ruby) -> Value

Convert self into Value.

fn into_value(self) -> Value

Convert self into Value.

unsafe fn into_value_unchecked(self) -> Value

Convert self into Value.

impl Numeric for RComplex

fn coerce_bin<T, ID, U>(self, other: T, op: ID) -> Result<U, Error>

where T: Numeric, ID: IntoId, U: TryConvert,

Apply the operator op with coercion.

fn coerce_cmp<T, ID, U>(self, other: T, op: ID) -> Result<U, Error>

where T: Numeric, ID: IntoId, U: TryConvert,

Apply the operator op with coercion.

fn coerce_relop<T, ID, U>(self, other: T, op: ID) -> Result<U, Error>

where T: Numeric, ID: IntoId, U: TryConvert,

Apply the operator op with coercion.

fn coerce_bit<T, ID, U>(self, other: T, op: ID) -> Result<U, Error>

where T: Numeric, ID: IntoId, U: TryConvert,

Apply the operator op with coercion.

impl ReprValue for RComplex

fn as_value(self) -> Value

Return self as a Value.

fn is_nil(self) -> bool

Returns whether self is Ruby’s nil value.

fn equal<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #==.

fn eql<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #eql?.

fn hash(self) -> Result<Integer, Error>

Returns an integer non-uniquely identifying self.

fn class(self) -> RClass

Returns the class that self is an instance of.

fn is_frozen(self) -> bool

Returns whether self is ‘frozen’.

fn check_frozen(self) -> Result<(), Error>

Returns an error if self is ‘frozen’.

fn freeze(self)

Mark self as frozen.

fn to_bool(self) -> bool

Convert self to a bool, following Ruby’s rules of false and nil as boolean false and everything else boolean true.

fn funcall<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args.

fn funcall_public<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the public method named method on self with args.

fn check_funcall<M, A, T>(self, method: M, args: A) -> Option<Result<T, Error>>

where M: IntoId, A: ArgList, T: TryConvert,

If self responds to the method named method, call it with args.

fn funcall_with_block<M, A, T>( self, method: M, args: A, block: Proc ) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args and block.

fn block_call<M, A, R, T>( self, method: M, args: A, block: fn(_: &[Value], _: Option<Proc>) -> R ) -> Result<T, Error>

where M: IntoId, A: ArgList, R: BlockReturn, T: TryConvert,

Call the method named method on self with args and block.

fn respond_to<M>(self, method: M, include_private: bool) -> Result<bool, Error>

where M: IntoId,

Check if self responds to the given Ruby method.

fn to_r_string(self) -> Result<RString, Error>

Convert self to a Ruby String.

unsafe fn to_s(&self) -> Result<Cow<'_, str>, Error>

Convert self to a Rust string.

fn inspect(self) -> String

Convert self to its Ruby debug representation.

unsafe fn classname(&self) -> Cow<'_, str>

Return the name of self’s class.

fn is_kind_of<T>(self, class: T) -> bool

where T: ReprValue + Module,

Returns whether or not self is an instance of class.

fn enumeratorize<M, A>(self, method: M, args: A) -> Enumerator

where M: IntoSymbol, A: ArgList,

Generate an Enumerator from method on self, passing args to method.

impl TryConvert for RComplex

fn try_convert(val: Value) -> Result<Self, Error>

Convert val into Self.

impl Copy for RComplex