Skip to main content

NDArray

apple_mps::ndarray

Struct NDArray 

Source 
pub struct NDArray { /* private fields */ }

Implementations§

Source§

impl NDArray

Source

pub const fn as_ptr(&self) -> *mut c_void

Source§

impl NDArray

Source

pub fn new(device: &MetalDevice, descriptor: &NDArrayDescriptor) -> Option<Self>

Examples found in repository?
examples/06_ndarray_matrix_multiplication.rs (line 31)
26fn main() {
27    let device = MetalDevice::system_default().expect("no Metal device available");
28    let queue = device.new_command_queue().expect("command queue");
29
30    let descriptor = NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[2, 2, 1, 1]).expect("descriptor");
31    let template = NDArray::new(&device, &descriptor).expect("template ndarray");
32    let byte_len = template.resource_size();
33    let rows = descriptor.length_of_dimension(1);
34    let row_stride_floats = byte_len / core::mem::size_of::<f32>() / rows;
35    let left_buffer = buffer_with_f32_values_padded(
36        &device,
37        &[1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0],
38        byte_len,
39    );
40    let right_buffer = buffer_with_f32_values_padded(
41        &device,
42        &[5.0, 6.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0],
43        byte_len,
44    );
45    let destination_buffer = buffer_with_f32_values_padded(&device, &[0.0; 8], byte_len);
46
47    let left = NDArray::new_with_buffer(&left_buffer, 0, &descriptor).expect("left ndarray");
48    let right = NDArray::new_with_buffer(&right_buffer, 0, &descriptor).expect("right ndarray");
49    let destination = NDArray::new_with_buffer(&destination_buffer, 0, &descriptor).expect("destination ndarray");
50
51    let kernel = NDArrayMatrixMultiplication::new(&device, 2).expect("ndarray matmul");
52    kernel.set_alpha(1.0);
53    kernel.set_beta(0.0);
54
55    let command_buffer = queue.new_command_buffer().expect("command buffer");
56    kernel.encode_to_destination(&command_buffer, &[&left, &right], &destination);
57    command_buffer.commit();
58    command_buffer.wait_until_completed();
59
60    let padded_output = read_f32_values(&destination_buffer, row_stride_floats * rows);
61    let output = [
62        padded_output[0],
63        padded_output[1],
64        padded_output[row_stride_floats],
65        padded_output[row_stride_floats + 1],
66    ];
67    println!("{output:?}");
68}
More examples
Hide additional examples
examples/03_ndarray_identity.rs (line 20)
4fn main() {
5    let device = MetalDevice::system_default().expect("no Metal device available");
6    let queue = device.new_command_queue().expect("command queue");
7
8    let descriptor =
9        NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[4]).expect("descriptor");
10    assert_eq!(descriptor.number_of_dimensions(), 1);
11    assert_eq!(descriptor.length_of_dimension(0), 4);
12
13    descriptor.reshape_with_dimension_sizes(&[2, 2]);
14    assert_eq!(descriptor.number_of_dimensions(), 2);
15    assert_eq!(descriptor.length_of_dimension(0), 2);
16    assert_eq!(descriptor.length_of_dimension(1), 2);
17
18    let array_descriptor = NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[2, 2])
19        .expect("array descriptor");
20    let array = NDArray::new(&device, &array_descriptor).expect("ndarray");
21    assert_eq!(array.number_of_dimensions(), 2);
22    assert_eq!(array.length_of_dimension(0), 2);
23    assert!(array.resource_size() > 0);
24
25    if let Some(identity) = NDArrayIdentity::new(&device) {
26        let destination_descriptor =
27            NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[4])
28                .expect("destination descriptor");
29        let destination =
30            NDArray::new(&device, &destination_descriptor).expect("destination ndarray");
31        let command_buffer = queue.new_command_buffer().expect("command buffer");
32        assert!(identity.reshape_into(Some(&command_buffer), &array, &[4], &destination));
33        command_buffer.commit();
34        command_buffer.wait_until_completed();
35        assert_eq!(destination.number_of_dimensions(), 1);
36        assert_eq!(destination.length_of_dimension(0), 4);
37        println!(
38            "ndarray smoke passed: resource_size={} dims={}x{}",
39            array.resource_size(),
40            array.length_of_dimension(0),
41            array.length_of_dimension(1)
42        );
43    } else {
44        println!("ndarray smoke skipped: MPSNDArrayIdentity unavailable on this macOS version");
45    }
46}
Source

pub fn scalar(device: &MetalDevice, value: f64) -> Option<Self>

Source

pub fn new_with_buffer( buffer: &MetalBuffer, offset: usize, descriptor: &NDArrayDescriptor, ) -> Option<Self>

Examples found in repository?
examples/06_ndarray_matrix_multiplication.rs (line 47)
26fn main() {
27    let device = MetalDevice::system_default().expect("no Metal device available");
28    let queue = device.new_command_queue().expect("command queue");
29
30    let descriptor = NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[2, 2, 1, 1]).expect("descriptor");
31    let template = NDArray::new(&device, &descriptor).expect("template ndarray");
32    let byte_len = template.resource_size();
33    let rows = descriptor.length_of_dimension(1);
34    let row_stride_floats = byte_len / core::mem::size_of::<f32>() / rows;
35    let left_buffer = buffer_with_f32_values_padded(
36        &device,
37        &[1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0],
38        byte_len,
39    );
40    let right_buffer = buffer_with_f32_values_padded(
41        &device,
42        &[5.0, 6.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0],
43        byte_len,
44    );
45    let destination_buffer = buffer_with_f32_values_padded(&device, &[0.0; 8], byte_len);
46
47    let left = NDArray::new_with_buffer(&left_buffer, 0, &descriptor).expect("left ndarray");
48    let right = NDArray::new_with_buffer(&right_buffer, 0, &descriptor).expect("right ndarray");
49    let destination = NDArray::new_with_buffer(&destination_buffer, 0, &descriptor).expect("destination ndarray");
50
51    let kernel = NDArrayMatrixMultiplication::new(&device, 2).expect("ndarray matmul");
52    kernel.set_alpha(1.0);
53    kernel.set_beta(0.0);
54
55    let command_buffer = queue.new_command_buffer().expect("command buffer");
56    kernel.encode_to_destination(&command_buffer, &[&left, &right], &destination);
57    command_buffer.commit();
58    command_buffer.wait_until_completed();
59
60    let padded_output = read_f32_values(&destination_buffer, row_stride_floats * rows);
61    let output = [
62        padded_output[0],
63        padded_output[1],
64        padded_output[row_stride_floats],
65        padded_output[row_stride_floats + 1],
66    ];
67    println!("{output:?}");
68}
Source

pub fn data_type(&self) -> u32

Source

pub fn number_of_dimensions(&self) -> usize

Examples found in repository?
examples/03_ndarray_identity.rs (line 21)
4fn main() {
5    let device = MetalDevice::system_default().expect("no Metal device available");
6    let queue = device.new_command_queue().expect("command queue");
7
8    let descriptor =
9        NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[4]).expect("descriptor");
10    assert_eq!(descriptor.number_of_dimensions(), 1);
11    assert_eq!(descriptor.length_of_dimension(0), 4);
12
13    descriptor.reshape_with_dimension_sizes(&[2, 2]);
14    assert_eq!(descriptor.number_of_dimensions(), 2);
15    assert_eq!(descriptor.length_of_dimension(0), 2);
16    assert_eq!(descriptor.length_of_dimension(1), 2);
17
18    let array_descriptor = NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[2, 2])
19        .expect("array descriptor");
20    let array = NDArray::new(&device, &array_descriptor).expect("ndarray");
21    assert_eq!(array.number_of_dimensions(), 2);
22    assert_eq!(array.length_of_dimension(0), 2);
23    assert!(array.resource_size() > 0);
24
25    if let Some(identity) = NDArrayIdentity::new(&device) {
26        let destination_descriptor =
27            NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[4])
28                .expect("destination descriptor");
29        let destination =
30            NDArray::new(&device, &destination_descriptor).expect("destination ndarray");
31        let command_buffer = queue.new_command_buffer().expect("command buffer");
32        assert!(identity.reshape_into(Some(&command_buffer), &array, &[4], &destination));
33        command_buffer.commit();
34        command_buffer.wait_until_completed();
35        assert_eq!(destination.number_of_dimensions(), 1);
36        assert_eq!(destination.length_of_dimension(0), 4);
37        println!(
38            "ndarray smoke passed: resource_size={} dims={}x{}",
39            array.resource_size(),
40            array.length_of_dimension(0),
41            array.length_of_dimension(1)
42        );
43    } else {
44        println!("ndarray smoke skipped: MPSNDArrayIdentity unavailable on this macOS version");
45    }
46}
Source

pub fn length_of_dimension(&self, dimension_index: usize) -> usize

Examples found in repository?
examples/03_ndarray_identity.rs (line 22)
4fn main() {
5    let device = MetalDevice::system_default().expect("no Metal device available");
6    let queue = device.new_command_queue().expect("command queue");
7
8    let descriptor =
9        NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[4]).expect("descriptor");
10    assert_eq!(descriptor.number_of_dimensions(), 1);
11    assert_eq!(descriptor.length_of_dimension(0), 4);
12
13    descriptor.reshape_with_dimension_sizes(&[2, 2]);
14    assert_eq!(descriptor.number_of_dimensions(), 2);
15    assert_eq!(descriptor.length_of_dimension(0), 2);
16    assert_eq!(descriptor.length_of_dimension(1), 2);
17
18    let array_descriptor = NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[2, 2])
19        .expect("array descriptor");
20    let array = NDArray::new(&device, &array_descriptor).expect("ndarray");
21    assert_eq!(array.number_of_dimensions(), 2);
22    assert_eq!(array.length_of_dimension(0), 2);
23    assert!(array.resource_size() > 0);
24
25    if let Some(identity) = NDArrayIdentity::new(&device) {
26        let destination_descriptor =
27            NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[4])
28                .expect("destination descriptor");
29        let destination =
30            NDArray::new(&device, &destination_descriptor).expect("destination ndarray");
31        let command_buffer = queue.new_command_buffer().expect("command buffer");
32        assert!(identity.reshape_into(Some(&command_buffer), &array, &[4], &destination));
33        command_buffer.commit();
34        command_buffer.wait_until_completed();
35        assert_eq!(destination.number_of_dimensions(), 1);
36        assert_eq!(destination.length_of_dimension(0), 4);
37        println!(
38            "ndarray smoke passed: resource_size={} dims={}x{}",
39            array.resource_size(),
40            array.length_of_dimension(0),
41            array.length_of_dimension(1)
42        );
43    } else {
44        println!("ndarray smoke skipped: MPSNDArrayIdentity unavailable on this macOS version");
45    }
46}
Source

pub fn descriptor(&self) -> Option<NDArrayDescriptor>

Source

pub fn resource_size(&self) -> usize

Examples found in repository?
examples/06_ndarray_matrix_multiplication.rs (line 32)
26fn main() {
27    let device = MetalDevice::system_default().expect("no Metal device available");
28    let queue = device.new_command_queue().expect("command queue");
29
30    let descriptor = NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[2, 2, 1, 1]).expect("descriptor");
31    let template = NDArray::new(&device, &descriptor).expect("template ndarray");
32    let byte_len = template.resource_size();
33    let rows = descriptor.length_of_dimension(1);
34    let row_stride_floats = byte_len / core::mem::size_of::<f32>() / rows;
35    let left_buffer = buffer_with_f32_values_padded(
36        &device,
37        &[1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0],
38        byte_len,
39    );
40    let right_buffer = buffer_with_f32_values_padded(
41        &device,
42        &[5.0, 6.0, 0.0, 0.0, 7.0, 8.0, 0.0, 0.0],
43        byte_len,
44    );
45    let destination_buffer = buffer_with_f32_values_padded(&device, &[0.0; 8], byte_len);
46
47    let left = NDArray::new_with_buffer(&left_buffer, 0, &descriptor).expect("left ndarray");
48    let right = NDArray::new_with_buffer(&right_buffer, 0, &descriptor).expect("right ndarray");
49    let destination = NDArray::new_with_buffer(&destination_buffer, 0, &descriptor).expect("destination ndarray");
50
51    let kernel = NDArrayMatrixMultiplication::new(&device, 2).expect("ndarray matmul");
52    kernel.set_alpha(1.0);
53    kernel.set_beta(0.0);
54
55    let command_buffer = queue.new_command_buffer().expect("command buffer");
56    kernel.encode_to_destination(&command_buffer, &[&left, &right], &destination);
57    command_buffer.commit();
58    command_buffer.wait_until_completed();
59
60    let padded_output = read_f32_values(&destination_buffer, row_stride_floats * rows);
61    let output = [
62        padded_output[0],
63        padded_output[1],
64        padded_output[row_stride_floats],
65        padded_output[row_stride_floats + 1],
66    ];
67    println!("{output:?}");
68}
More examples
Hide additional examples
examples/03_ndarray_identity.rs (line 23)
4fn main() {
5    let device = MetalDevice::system_default().expect("no Metal device available");
6    let queue = device.new_command_queue().expect("command queue");
7
8    let descriptor =
9        NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[4]).expect("descriptor");
10    assert_eq!(descriptor.number_of_dimensions(), 1);
11    assert_eq!(descriptor.length_of_dimension(0), 4);
12
13    descriptor.reshape_with_dimension_sizes(&[2, 2]);
14    assert_eq!(descriptor.number_of_dimensions(), 2);
15    assert_eq!(descriptor.length_of_dimension(0), 2);
16    assert_eq!(descriptor.length_of_dimension(1), 2);
17
18    let array_descriptor = NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[2, 2])
19        .expect("array descriptor");
20    let array = NDArray::new(&device, &array_descriptor).expect("ndarray");
21    assert_eq!(array.number_of_dimensions(), 2);
22    assert_eq!(array.length_of_dimension(0), 2);
23    assert!(array.resource_size() > 0);
24
25    if let Some(identity) = NDArrayIdentity::new(&device) {
26        let destination_descriptor =
27            NDArrayDescriptor::with_dimension_sizes(data_type::FLOAT32, &[4])
28                .expect("destination descriptor");
29        let destination =
30            NDArray::new(&device, &destination_descriptor).expect("destination ndarray");
31        let command_buffer = queue.new_command_buffer().expect("command buffer");
32        assert!(identity.reshape_into(Some(&command_buffer), &array, &[4], &destination));
33        command_buffer.commit();
34        command_buffer.wait_until_completed();
35        assert_eq!(destination.number_of_dimensions(), 1);
36        assert_eq!(destination.length_of_dimension(0), 4);
37        println!(
38            "ndarray smoke passed: resource_size={} dims={}x{}",
39            array.resource_size(),
40            array.length_of_dimension(0),
41            array.length_of_dimension(1)
42        );
43    } else {
44        println!("ndarray smoke skipped: MPSNDArrayIdentity unavailable on this macOS version");
45    }
46}

Trait Implementations§

Source§

impl Drop for NDArray

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Send for NDArray

Source§

impl Sync for NDArray

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.