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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

//! Happy-path tests for `ops::comparison`.
//!
//! Element-wise comparisons return Bool arrays; query ops (`isfinite`/etc.)
//! exercise the unary template; `allclose`/`isclose` exercise the
//! tolerance-bearing trinary template (rtol/atol/equal_nan).

use mlxrs::Array;

#[test]
fn equal_componentwise() {
  let a = Array::from_slice::<f32>(&[1.0, 2.0, 3.0, 4.0], &(4,)).unwrap();
  let b = Array::from_slice::<f32>(&[1.0, 9.0, 3.0, 0.0], &(4,)).unwrap();
  let mut r = a.equal(&b).unwrap();
  assert_eq!(r.to_vec::<bool>().unwrap(), vec![true, false, true, false]);
}

#[test]
fn not_equal_componentwise() {
  let a = Array::from_slice::<f32>(&[1.0, 2.0, 3.0], &(3,)).unwrap();
  let b = Array::from_slice::<f32>(&[1.0, 0.0, 3.0], &(3,)).unwrap();
  let mut r = a.not_equal(&b).unwrap();
  assert_eq!(r.to_vec::<bool>().unwrap(), vec![false, true, false]);
}

#[test]
fn less_componentwise() {
  let a = Array::from_slice::<f32>(&[1.0, 2.0, 3.0], &(3,)).unwrap();
  let b = Array::from_slice::<f32>(&[2.0, 2.0, 0.0], &(3,)).unwrap();
  let mut r = a.less(&b).unwrap();
  assert_eq!(r.to_vec::<bool>().unwrap(), vec![true, false, false]);
}

#[test]
fn less_equal_componentwise() {
  let a = Array::from_slice::<f32>(&[1.0, 2.0, 3.0], &(3,)).unwrap();
  let b = Array::from_slice::<f32>(&[2.0, 2.0, 0.0], &(3,)).unwrap();
  let mut r = a.less_equal(&b).unwrap();
  assert_eq!(r.to_vec::<bool>().unwrap(), vec![true, true, false]);
}

#[test]
fn greater_componentwise() {
  let a = Array::from_slice::<f32>(&[1.0, 2.0, 3.0], &(3,)).unwrap();
  let b = Array::from_slice::<f32>(&[2.0, 2.0, 0.0], &(3,)).unwrap();
  let mut r = a.greater(&b).unwrap();
  assert_eq!(r.to_vec::<bool>().unwrap(), vec![false, false, true]);
}

#[test]
fn greater_equal_componentwise() {
  let a = Array::from_slice::<f32>(&[1.0, 2.0, 3.0], &(3,)).unwrap();
  let b = Array::from_slice::<f32>(&[2.0, 2.0, 0.0], &(3,)).unwrap();
  let mut r = a.greater_equal(&b).unwrap();
  assert_eq!(r.to_vec::<bool>().unwrap(), vec![false, true, true]);
}

#[test]
fn allclose_within_tol_returns_true() {
  // Differences ~1e-5 are well within the default rtol=1e-5, atol=1e-8 envelope.
  let a = Array::from_slice::<f32>(&[1.0, 2.0, 3.0], &(3,)).unwrap();
  let b = Array::from_slice::<f32>(&[1.000001, 2.000001, 3.000001], &(3,)).unwrap();
  let mut r = a.allclose(&b, 1e-5, 1e-8, false).unwrap();
  assert!(r.item::<bool>().unwrap());
}

#[test]
fn allclose_outside_tol_returns_false() {
  let a = Array::from_slice::<f32>(&[1.0, 2.0, 3.0], &(3,)).unwrap();
  let b = Array::from_slice::<f32>(&[1.0, 2.5, 3.0], &(3,)).unwrap();
  let mut r = a.allclose(&b, 1e-5, 1e-8, false).unwrap();
  assert!(!r.item::<bool>().unwrap());
}

#[test]
fn isclose_componentwise() {
  let a = Array::from_slice::<f32>(&[1.0, 2.0, 3.0], &(3,)).unwrap();
  let b = Array::from_slice::<f32>(&[1.000001, 9.0, 3.0], &(3,)).unwrap();
  let mut r = a.isclose(&b, 1e-5, 1e-8, false).unwrap();
  assert_eq!(r.to_vec::<bool>().unwrap(), vec![true, false, true]);
}

#[test]
fn isfinite_marks_inf_and_nan_as_false() {
  let a = Array::from_slice::<f32>(
    &[0.0, 1.0, f32::INFINITY, f32::NEG_INFINITY, f32::NAN],
    &(5,),
  )
  .unwrap();
  let mut r = a.isfinite().unwrap();
  assert_eq!(
    r.to_vec::<bool>().unwrap(),
    vec![true, true, false, false, false]
  );
}

#[test]
fn isinf_marks_only_infinities() {
  let a = Array::from_slice::<f32>(
    &[0.0, 1.0, f32::INFINITY, f32::NEG_INFINITY, f32::NAN],
    &(5,),
  )
  .unwrap();
  let mut r = a.isinf().unwrap();
  assert_eq!(
    r.to_vec::<bool>().unwrap(),
    vec![false, false, true, true, false]
  );
}

#[test]
fn isnan_marks_only_nan() {
  let a = Array::from_slice::<f32>(
    &[0.0, 1.0, f32::INFINITY, f32::NEG_INFINITY, f32::NAN],
    &(5,),
  )
  .unwrap();
  let mut r = a.isnan().unwrap();
  assert_eq!(
    r.to_vec::<bool>().unwrap(),
    vec![false, false, false, false, true]
  );
}

#[test]
fn isposinf_marks_only_positive_infinity() {
  // +inf → true; everything else (finite, -inf, nan) → false. Distinguishes
  // isposinf from isinf (which would also flag the -inf slot).
  let a = Array::from_slice::<f32>(
    &[0.0, 1.0, f32::INFINITY, f32::NEG_INFINITY, f32::NAN],
    &(5,),
  )
  .unwrap();
  let mut r = a.isposinf().unwrap();
  assert_eq!(
    r.to_vec::<bool>().unwrap(),
    vec![false, false, true, false, false]
  );
}

#[test]
fn isneginf_marks_only_negative_infinity() {
  // -inf → true; everything else (finite, +inf, nan) → false. The mirror of
  // isposinf; together they partition isinf's two true positions.
  let a = Array::from_slice::<f32>(
    &[0.0, 1.0, f32::INFINITY, f32::NEG_INFINITY, f32::NAN],
    &(5,),
  )
  .unwrap();
  let mut r = a.isneginf().unwrap();
  assert_eq!(
    r.to_vec::<bool>().unwrap(),
    vec![false, false, false, true, false]
  );
}

#[test]
fn isposinf_isneginf_on_integer_input_all_false() {
  // Integer dtypes cannot hold inf; mlx returns an all-false bool mask for
  // both predicates (the `issubdtype(integer)` early return in ops.cpp).
  let a = Array::from_slice::<i32>(&[-5, 0, 7], &(3,)).unwrap();
  let mut pos = a.isposinf().unwrap();
  assert_eq!(pos.dtype().unwrap(), mlxrs::Dtype::Bool);
  assert_eq!(pos.to_vec::<bool>().unwrap(), vec![false, false, false]);
  let mut neg = a.isneginf().unwrap();
  assert_eq!(neg.to_vec::<bool>().unwrap(), vec![false, false, false]);
}