mlxrs 0.1.0

Safe Rust bindings for Apple's MLX array framework, with LM, VLM, audio, and embeddings support
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

//! Arithmetic op happy-path tests.
//!
//! Each wrapper gets at least one assertion against a non-trivial scalar/vec
//! value. Method-form is exercised when convenient; free-fn parity is
//! identical so we don't double-test it everywhere.

use mlxrs::Array;

// ───────── Binary ops ─────────

#[test]
fn subtract_2_minus_3_yields_neg1() {
  let a = Array::full::<f32>(&(2, 2), 2.0).unwrap();
  let b = Array::full::<f32>(&(2, 2), 3.0).unwrap();
  let mut r = a.subtract(&b).unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![-1.0; 4]);
}

#[test]
fn multiply_2_times_3_yields_6() {
  let a = Array::full::<f32>(&(3,), 2.0).unwrap();
  let b = Array::full::<f32>(&(3,), 3.0).unwrap();
  let mut r = a.multiply(&b).unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![6.0; 3]);
}

#[test]
fn divide_6_over_2_yields_3() {
  let a = Array::full::<f32>(&(2, 2), 6.0).unwrap();
  let b = Array::full::<f32>(&(2, 2), 2.0).unwrap();
  let mut r = a.divide(&b).unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![3.0; 4]);
}

#[test]
fn maximum_picks_larger_elementwise() {
  let a = Array::from_slice(&[1.0_f32, 5.0, 2.0, 4.0], &(4,)).unwrap();
  let b = Array::from_slice(&[3.0_f32, 2.0, 6.0, 1.0], &(4,)).unwrap();
  let mut r = a.maximum(&b).unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![3.0, 5.0, 6.0, 4.0]);
}

#[test]
fn minimum_picks_smaller_elementwise() {
  let a = Array::from_slice(&[1.0_f32, 5.0, 2.0, 4.0], &(4,)).unwrap();
  let b = Array::from_slice(&[3.0_f32, 2.0, 6.0, 1.0], &(4,)).unwrap();
  let mut r = a.minimum(&b).unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![1.0, 2.0, 2.0, 1.0]);
}

#[test]
fn power_2_to_3_yields_8() {
  let a = Array::full::<f32>(&(2,), 2.0).unwrap();
  let b = Array::full::<f32>(&(2,), 3.0).unwrap();
  let mut r = a.power(&b).unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![8.0, 8.0]);
}

#[test]
fn add_freefn_parity_with_method() {
  // Sanity check that the free-fn and method form produce identical scalar.
  let a = Array::full::<f32>(&(1,), 4.0).unwrap();
  let b = Array::full::<f32>(&(1,), 5.0).unwrap();
  let mut method = a.add(&b).unwrap();
  let mut freefn = mlxrs::ops::arithmetic::add(&a, &b).unwrap();
  assert_eq!(method.item::<f32>().unwrap(), freefn.item::<f32>().unwrap());
}

// ───────── Unary ops ─────────

#[test]
fn negative_flips_sign() {
  let a = Array::from_slice(&[1.0_f32, -2.0, 3.0], &(3,)).unwrap();
  let mut r = a.negative().unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![-1.0, 2.0, -3.0]);
}

#[test]
fn abs_makes_positive() {
  let a = Array::from_slice(&[-1.0_f32, 2.0, -3.0], &(3,)).unwrap();
  let mut r = a.abs().unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![1.0, 2.0, 3.0]);
}

#[test]
fn sqrt_of_4_yields_2() {
  let a = Array::full::<f32>(&(2,), 4.0).unwrap();
  let mut r = a.sqrt().unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![2.0, 2.0]);
}

#[test]
fn square_of_3_yields_9() {
  let a = Array::full::<f32>(&(2,), 3.0).unwrap();
  let mut r = a.square().unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![9.0, 9.0]);
}

#[test]
fn exp_of_0_yields_1() {
  let a = Array::full::<f32>(&(2,), 0.0).unwrap();
  let mut r = a.exp().unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![1.0, 1.0]);
}

#[test]
fn log_of_1_yields_0() {
  let a = Array::full::<f32>(&(2,), 1.0).unwrap();
  let mut r = a.log().unwrap();
  assert_eq!(r.to_vec::<f32>().unwrap(), vec![0.0, 0.0]);
}

#[test]
fn sin_of_0_yields_0() {
  let a = Array::full::<f32>(&(1,), 0.0).unwrap();
  let mut r = a.sin().unwrap();
  assert_eq!(r.item::<f32>().unwrap(), 0.0);
}

#[test]
fn cos_of_0_yields_1() {
  let a = Array::full::<f32>(&(1,), 0.0).unwrap();
  let mut r = a.cos().unwrap();
  assert_eq!(r.item::<f32>().unwrap(), 1.0);
}

#[test]
fn tan_of_0_yields_0() {
  let a = Array::full::<f32>(&(1,), 0.0).unwrap();
  let mut r = a.tan().unwrap();
  assert_eq!(r.item::<f32>().unwrap(), 0.0);
}

#[test]
fn tanh_of_0_yields_0() {
  let a = Array::full::<f32>(&(1,), 0.0).unwrap();
  let mut r = a.tanh().unwrap();
  assert_eq!(r.item::<f32>().unwrap(), 0.0);
}

#[test]
fn tanh_of_large_saturates_near_1() {
  // tanh(10) ≈ 0.99999998; quick sanity that it's within 1e-6 of 1.
  let a = Array::full::<f32>(&(1,), 10.0).unwrap();
  let mut r = a.tanh().unwrap();
  let v = r.item::<f32>().unwrap();
  assert!((v - 1.0).abs() < 1e-6, "tanh(10) = {v}, expected ≈ 1.0");
}