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

// Copyright 2019 ndarray developers.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use crate::imp_prelude::*;

/// Methods specific to `CowArray`.
///
/// ***See also all methods for [`ArrayBase`]***
impl<'a, A, D> CowArray<'a, A, D>
where
    D: Dimension,
{
    /// Returns `true` iff the array is the view (borrowed) variant.
    pub fn is_view(&self) -> bool {
        self.data.is_view()
    }

    /// Returns `true` iff the array is the owned variant.
    pub fn is_owned(&self) -> bool {
        self.data.is_owned()
    }
}

impl<'a, A, D> From<ArrayView<'a, A, D>> for CowArray<'a, A, D>
where
    D: Dimension,
{
    fn from(view: ArrayView<'a, A, D>) -> CowArray<'a, A, D> {
        // safe because equivalent data
        unsafe {
            ArrayBase::from_data_ptr(CowRepr::View(view.data), view.ptr)
                .with_strides_dim(view.strides, view.dim)
        }
    }
}

impl<'a, A, D> From<Array<A, D>> for CowArray<'a, A, D>
where
    D: Dimension,
{
    fn from(array: Array<A, D>) -> CowArray<'a, A, D> {
        // safe because equivalent data
        unsafe {
            ArrayBase::from_data_ptr(CowRepr::Owned(array.data), array.ptr)
                .with_strides_dim(array.strides, array.dim)
        }
    }
}

impl<'a, A, Slice: ?Sized> From<&'a Slice> for CowArray<'a, A, Ix1>
where
    Slice: AsRef<[A]>,
{
    /// Create a one-dimensional clone-on-write view of the data in `slice`.
    ///
    /// **Panics** if the slice length is greater than [`isize::MAX`].
    ///
    /// ```
    /// use ndarray::{array, CowArray};
    ///
    /// let array = CowArray::from(&[1., 2., 3., 4.]);
    /// assert!(array.is_view());
    /// assert_eq!(array, array![1., 2., 3., 4.]);
    /// ```
    fn from(slice: &'a Slice) -> Self {
        Self::from(ArrayView1::from(slice))
    }
}

impl<'a, A, S, D> From<&'a ArrayBase<S, D>> for CowArray<'a, A, D>
where
    S: Data<Elem = A>,
    D: Dimension,
{
    /// Create a read-only clone-on-write view of the array.
    fn from(array: &'a ArrayBase<S, D>) -> Self {
        Self::from(array.view())
    }
}