zyx 0.14.0

Zyx machine learning library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

//! Trait describing required operations on scalar values

#[cfg(feature = "half")]
mod scalar_bf16;
mod scalar_bool;
#[cfg(feature = "complex")]
mod scalar_cf32;
#[cfg(feature = "complex")]
mod scalar_cf64;
#[cfg(feature = "half")]
mod scalar_f16;
mod scalar_f32;
mod scalar_f64;
mod scalar_i16;
mod scalar_i32;
mod scalar_i64;
mod scalar_i8;
mod scalar_u8;

#[cfg(feature = "complex")]
use num_complex::Complex;

#[cfg(feature = "half")]
use half::{bf16, f16};

use crate::dtype::DType;

/// Scalar trait is implemented for all [dtypes](DType)
pub trait Scalar: Copy + Clone + Sized + core::fmt::Debug + 'static + PartialEq {
    /// From bf16
    #[cfg(feature = "half")]
    fn from_bf16(t: bf16) -> Self;
    /// From f16
    #[cfg(feature = "half")]
    fn from_f16(t: f16) -> Self;
    /// From f32
    fn from_f32(t: f32) -> Self;
    /// From f64
    fn from_f64(t: f64) -> Self;
    /// From complex f32
    #[cfg(feature = "complex")]
    fn from_cf32(t: Complex<f32>) -> Self;
    /// From complex f64
    #[cfg(feature = "complex")]
    fn from_cf64(t: Complex<f64>) -> Self;
    /// From u8
    fn from_u8(t: u8) -> Self;
    /// From i8
    fn from_i8(t: i8) -> Self;
    /// From i16
    fn from_i16(t: i16) -> Self;
    /// From i32
    fn from_i32(t: i32) -> Self;
    /// From i64
    fn from_i64(t: i64) -> Self;
    /// From bool
    fn from_bool(t: bool) -> Self;
    /// From little endian bytes
    fn from_le_bytes(bytes: &[u8]) -> Self;
    /// Get dtype of Self
    fn dtype() -> DType;
    /// Get zero of Self
    fn zero() -> Self;
    /// Get one of Self
    fn one() -> Self;
    /// Bute size of Self
    fn byte_size() -> usize;
    /// Absolute value of self
    fn abs(self) -> Self;
    /// 1/self
    fn reciprocal(self) -> Self;
    /// Round down
    fn floor(self) -> Self;
    /// Neg
    fn neg(self) -> Self;
    /// ReLU
    fn relu(self) -> Self;
    /// Sin
    fn sin(self) -> Self;
    /// Cos
    fn cos(self) -> Self;
    /// Exp 2
    fn exp2(self) -> Self;
    /// Log 2
    fn log2(self) -> Self;
    /// Inv
    fn inv(self) -> Self;
    /// Not
    fn not(self) -> Self;
    /// Nonzero
    fn nonzero(self) -> Self;
    /// Square root of this scalar.
    /// That this function may be imprecise.
    fn sqrt(self) -> Self;
    /// Add
    fn add(self, rhs: Self) -> Self;
    /// Sub
    fn sub(self, rhs: Self) -> Self;
    /// Mul
    fn mul(self, rhs: Self) -> Self;
    /// Div
    fn div(self, rhs: Self) -> Self;
    /// Pow
    fn pow(self, rhs: Self) -> Self;
    /// Compare less than
    fn cmplt(self, rhs: Self) -> Self;
    /// Compare less than
    fn cmpgt(self, rhs: Self) -> Self;
    /// Compare less than
    fn or(self, rhs: Self) -> Self;
    /// Max of two numbers
    fn max(self, rhs: Self) -> Self;
    /// Max value of this dtype
    fn max_value() -> Self;
    /// Min value of this dtype
    fn min_value() -> Self;
    /// Very small value of scalar, very close to zero
    fn epsilon() -> Self;
    /// Comparison for scalars,
    /// if they are floats, this checks for diffs > Self::epsilon()
    fn is_equal(self, rhs: Self) -> bool;
    /// Cast into different dtype
    fn cast<T: Scalar>(self) -> T {
        use core::mem::transmute_copy as t;
        return unsafe {
            match Self::dtype() {
                #[cfg(feature = "half")]
                DType::BF16 => T::from_bf16(t(&self)),
                #[cfg(feature = "half")]
                DType::F16 => T::from_f16(t(&self)),
                DType::F32 => T::from_f32(t(&self)),
                DType::F64 => T::from_f64(t(&self)),
                #[cfg(feature = "complex")]
                DType::CF32 => T::from_cf32(t(&self)),
                #[cfg(feature = "complex")]
                DType::CF64 => T::from_cf64(t(&self)),
                DType::U8 => T::from_u8(t(&self)),
                DType::I8 => T::from_i8(t(&self)),
                DType::I16 => T::from_i16(t(&self)),
                DType::I32 => T::from_i32(t(&self)),
                DType::I64 => T::from_i64(t(&self)),
                DType::Bool => T::from_bool(t(&self)),
            }
        };
    }
}

pub trait Float: Scalar {}