use ferray_core::Array;
use ferray_core::dimension::Dimension;
use ferray_core::dtype::Element;
use ferray_core::error::{FerrayError, FerrayResult};
use crate::MaskedArray;
impl<T: Element, D: Dimension> AsRef<Array<T, D>> for MaskedArray<T, D> {
fn as_ref(&self) -> &Array<T, D> {
self.data()
}
}
impl<T: Element + Copy, D: Dimension> From<MaskedArray<T, D>> for Array<T, D> {
fn from(ma: MaskedArray<T, D>) -> Self {
ma.into_data()
}
}
impl<T, D> MaskedArray<T, D>
where
T: Element + Copy,
D: Dimension,
{
pub fn into_data(self) -> Array<T, D> {
self.data().clone()
}
pub fn apply_unary<F>(&self, f: F) -> FerrayResult<Self>
where
F: FnOnce(&Array<T, D>) -> FerrayResult<Array<T, D>>,
{
let data_out = f(self.data())?;
if data_out.shape() != self.shape() {
return Err(FerrayError::shape_mismatch(format!(
"apply_unary: function changed shape from {:?} to {:?}",
self.shape(),
data_out.shape()
)));
}
let fill = self.fill_value();
let masked_data: Vec<T> = data_out
.iter()
.zip(self.mask().iter())
.map(|(v, m)| if *m { fill } else { *v })
.collect();
let final_data = Array::from_vec(self.dim().clone(), masked_data)?;
let mut result = Self::new(final_data, self.mask().clone())?;
result.set_fill_value(fill);
Ok(result)
}
pub fn apply_unary_to<U, F>(
&self,
f: F,
default_for_masked: U,
) -> FerrayResult<MaskedArray<U, D>>
where
U: Element + Copy,
F: FnOnce(&Array<T, D>) -> FerrayResult<Array<U, D>>,
{
let data_out = f(self.data())?;
if data_out.shape() != self.shape() {
return Err(FerrayError::shape_mismatch(format!(
"apply_unary_to: function changed shape from {:?} to {:?}",
self.shape(),
data_out.shape()
)));
}
let masked_data: Vec<U> = data_out
.iter()
.zip(self.mask().iter())
.map(|(v, m)| if *m { default_for_masked } else { *v })
.collect();
let final_data = Array::from_vec(self.dim().clone(), masked_data)?;
let mut result = MaskedArray::new(final_data, self.mask().clone())?;
result.set_fill_value(default_for_masked);
Ok(result)
}
pub fn apply_binary<F>(&self, other: &Self, f: F) -> FerrayResult<Self>
where
F: FnOnce(&Array<T, D>, &Array<T, D>) -> FerrayResult<Array<T, D>>,
{
if self.shape() != other.shape() {
return Err(FerrayError::shape_mismatch(format!(
"apply_binary: shapes {:?} and {:?} differ",
self.shape(),
other.shape()
)));
}
let data_out = f(self.data(), other.data())?;
if data_out.shape() != self.shape() {
return Err(FerrayError::shape_mismatch(format!(
"apply_binary: function changed shape from {:?} to {:?}",
self.shape(),
data_out.shape()
)));
}
let union_data: Vec<bool> = self
.mask()
.iter()
.zip(other.mask().iter())
.map(|(a, b)| *a || *b)
.collect();
let union_mask = Array::from_vec(self.dim().clone(), union_data)?;
let fill = self.fill_value();
let masked_data: Vec<T> = data_out
.iter()
.zip(union_mask.iter())
.map(|(v, m)| if *m { fill } else { *v })
.collect();
let final_data = Array::from_vec(self.dim().clone(), masked_data)?;
let mut result = Self::new(final_data, union_mask)?;
result.set_fill_value(fill);
Ok(result)
}
}
#[cfg(test)]
mod tests {
use super::*;
use ferray_core::dimension::Ix1;
fn ma1(data: Vec<f64>, mask: Vec<bool>) -> MaskedArray<f64, Ix1> {
let n = data.len();
let d = Array::<f64, Ix1>::from_vec(Ix1::new([n]), data).unwrap();
let m = Array::<bool, Ix1>::from_vec(Ix1::new([n]), mask).unwrap();
MaskedArray::new(d, m).unwrap()
}
#[test]
fn as_ref_returns_underlying_data() {
let ma = ma1(vec![1.0, 2.0, 3.0], vec![false, true, false]);
let arr_ref: &Array<f64, Ix1> = ma.as_ref();
assert_eq!(arr_ref.shape(), &[3]);
let v: Vec<f64> = arr_ref.iter().copied().collect();
assert_eq!(v, vec![1.0, 2.0, 3.0]);
}
#[test]
fn from_masked_to_array_drops_mask() {
let ma = ma1(vec![1.0, 2.0, 3.0], vec![false, true, false]);
let arr: Array<f64, Ix1> = ma.into();
assert_eq!(arr.shape(), &[3]);
}
#[test]
fn into_data_method() {
let ma = ma1(vec![1.0, 2.0, 3.0], vec![false, true, false]);
let arr = ma.into_data();
assert_eq!(arr.shape(), &[3]);
}
#[test]
fn apply_unary_propagates_mask() {
let ma =
ma1(vec![1.0, 4.0, 9.0, 16.0], vec![false, false, true, false]).with_fill_value(-1.0);
let result = ma
.apply_unary(|arr| {
let data: Vec<f64> = arr.iter().map(|&x| x.sqrt()).collect();
Array::<f64, Ix1>::from_vec(Ix1::new([arr.size()]), data)
})
.unwrap();
let d: Vec<f64> = result.data().iter().copied().collect();
assert_eq!(d, vec![1.0, 2.0, -1.0, 4.0]);
let m: Vec<bool> = result.mask().iter().copied().collect();
assert_eq!(m, vec![false, false, true, false]);
assert_eq!(result.fill_value(), -1.0);
}
#[test]
fn apply_unary_forwards_error() {
let ma = ma1(vec![1.0, 2.0], vec![false, false]);
let result: FerrayResult<MaskedArray<f64, Ix1>> =
ma.apply_unary(|_| Err(FerrayError::invalid_value("simulated failure")));
assert!(result.is_err());
}
#[test]
fn apply_unary_rejects_shape_change() {
let ma = ma1(vec![1.0, 2.0, 3.0], vec![false, false, false]);
let result = ma.apply_unary(|_| Array::<f64, Ix1>::from_vec(Ix1::new([2]), vec![1.0, 2.0]));
assert!(result.is_err());
}
#[test]
fn apply_unary_to_changes_type_with_mask_default() {
let ma = ma1(vec![1.0, -2.0, 3.0, -4.0], vec![false, false, true, false]);
let result = ma
.apply_unary_to(
|arr| {
let data: Vec<bool> = arr.iter().map(|&x| x > 0.0).collect();
Array::<bool, Ix1>::from_vec(Ix1::new([arr.size()]), data)
},
false, )
.unwrap();
let d: Vec<bool> = result.data().iter().copied().collect();
assert_eq!(d, vec![true, false, false, false]);
let m: Vec<bool> = result.mask().iter().copied().collect();
assert_eq!(m, vec![false, false, true, false]);
}
#[test]
fn apply_binary_unions_masks() {
let a = ma1(vec![10.0, 20.0, 30.0], vec![false, true, false]).with_fill_value(-1.0);
let b = ma1(vec![1.0, 2.0, 3.0], vec![false, false, true]);
let result = a
.apply_binary(&b, |x, y| {
let data: Vec<f64> = x.iter().zip(y.iter()).map(|(&a, &b)| a + b).collect();
Array::<f64, Ix1>::from_vec(Ix1::new([x.size()]), data)
})
.unwrap();
let d: Vec<f64> = result.data().iter().copied().collect();
assert_eq!(d, vec![11.0, -1.0, -1.0]);
let m: Vec<bool> = result.mask().iter().copied().collect();
assert_eq!(m, vec![false, true, true]);
assert_eq!(result.fill_value(), -1.0);
}
#[test]
fn apply_binary_rejects_shape_mismatch() {
let a = ma1(vec![1.0, 2.0, 3.0], vec![false; 3]);
let b = ma1(vec![1.0, 2.0], vec![false; 2]);
let result = a.apply_binary(&b, |x, _y| Ok(x.clone()));
assert!(result.is_err());
}
#[test]
fn as_ref_works_with_array_consuming_function() {
fn double(arr: &Array<f64, Ix1>) -> FerrayResult<Array<f64, Ix1>> {
let data: Vec<f64> = arr.iter().map(|&x| x * 2.0).collect();
Array::<f64, Ix1>::from_vec(Ix1::new([arr.size()]), data)
}
let ma = ma1(vec![1.0, 2.0, 3.0], vec![false, true, false]);
let result = double(ma.as_ref()).unwrap();
let v: Vec<f64> = result.iter().copied().collect();
assert_eq!(v, vec![2.0, 4.0, 6.0]);
let masked_result = ma.apply_unary(double).unwrap();
let m: Vec<bool> = masked_result.mask().iter().copied().collect();
assert_eq!(m, vec![false, true, false]);
}
}
pub trait MaskAware<T: Element, D: Dimension> {
fn data(&self) -> &Array<T, D>;
fn mask_opt(&self) -> Option<&Array<bool, D>>;
fn fill_value(&self) -> T
where
T: Copy;
fn shape(&self) -> &[usize] {
self.data().shape()
}
}
impl<T: Element, D: Dimension> MaskAware<T, D> for Array<T, D> {
#[inline]
fn data(&self) -> &Self {
self
}
#[inline]
fn mask_opt(&self) -> Option<&Array<bool, D>> {
None
}
#[inline]
fn fill_value(&self) -> T
where
T: Copy,
{
T::zero()
}
}
impl<T: Element, D: Dimension> MaskAware<T, D> for MaskedArray<T, D> {
#[inline]
fn data(&self) -> &Array<T, D> {
Self::data(self)
}
#[inline]
fn mask_opt(&self) -> Option<&Array<bool, D>> {
Self::mask_opt(self)
}
#[inline]
fn fill_value(&self) -> T
where
T: Copy,
{
Self::fill_value(self)
}
}
pub fn ma_apply_unary<T, D, X, F>(input: &X, f: F) -> FerrayResult<MaskedArray<T, D>>
where
T: Element + Copy,
D: Dimension,
X: MaskAware<T, D>,
F: FnOnce(&Array<T, D>) -> FerrayResult<Array<T, D>>,
{
let data_out = f(input.data())?;
if data_out.shape() != input.shape() {
return Err(FerrayError::shape_mismatch(format!(
"ma_apply_unary: function changed shape from {:?} to {:?}",
input.shape(),
data_out.shape()
)));
}
match input.mask_opt() {
None => {
let mut out = MaskedArray::from_data(data_out)?;
out.set_fill_value(input.fill_value());
Ok(out)
}
Some(mask) => {
let fill = input.fill_value();
let masked_data: Vec<T> = data_out
.iter()
.zip(mask.iter())
.map(|(v, m)| if *m { fill } else { *v })
.collect();
let final_data = Array::from_vec(input.data().dim().clone(), masked_data)?;
let mut result = MaskedArray::new(final_data, mask.clone())?;
result.set_fill_value(fill);
Ok(result)
}
}
}
#[cfg(test)]
mod mask_aware_tests {
use super::*;
use ferray_core::dimension::Ix1;
fn arr_f64(data: Vec<f64>) -> Array<f64, Ix1> {
let n = data.len();
Array::<f64, Ix1>::from_vec(Ix1::new([n]), data).unwrap()
}
fn ma_f64(data: Vec<f64>, mask: Vec<bool>) -> MaskedArray<f64, Ix1> {
let d = arr_f64(data);
let n = d.size();
let m = Array::<bool, Ix1>::from_vec(Ix1::new([n]), mask).unwrap();
MaskedArray::new(d, m).unwrap()
}
#[test]
fn array_implements_mask_aware_with_none_mask() {
let a = arr_f64(vec![1.0, 2.0, 3.0]);
assert!(<Array<f64, Ix1> as MaskAware<f64, Ix1>>::mask_opt(&a).is_none());
assert_eq!(
<Array<f64, Ix1> as MaskAware<f64, Ix1>>::fill_value(&a),
0.0
);
assert_eq!(<Array<f64, Ix1> as MaskAware<f64, Ix1>>::shape(&a), &[3]);
}
#[test]
fn masked_array_implements_mask_aware_with_real_mask() {
let ma = ma_f64(vec![1.0, 2.0, 3.0], vec![false, true, false]);
let via_trait = <MaskedArray<f64, Ix1> as MaskAware<f64, Ix1>>::mask_opt(&ma);
assert!(via_trait.is_some());
assert_eq!(
via_trait.unwrap().iter().copied().collect::<Vec<_>>(),
vec![false, true, false]
);
}
#[test]
fn nomask_sentinel_masked_array_reports_none_via_trait() {
let ma = MaskedArray::from_data(arr_f64(vec![1.0, 2.0, 3.0])).unwrap();
let via_trait = <MaskedArray<f64, Ix1> as MaskAware<f64, Ix1>>::mask_opt(&ma);
assert!(via_trait.is_none());
}
#[test]
fn ma_apply_unary_on_plain_array_returns_nomask_result() {
let a = arr_f64(vec![1.0, 2.0, 3.0]);
let result = ma_apply_unary(&a, |x| {
let data: Vec<f64> = x.iter().map(|v| v * 2.0).collect();
Array::from_vec(x.dim().clone(), data)
})
.unwrap();
assert_eq!(
result.data().iter().copied().collect::<Vec<_>>(),
vec![2.0, 4.0, 6.0]
);
assert!(!result.has_real_mask());
}
#[test]
fn ma_apply_unary_on_masked_array_propagates_mask() {
let ma = ma_f64(vec![1.0, 2.0, 3.0], vec![false, true, false]);
let result = ma_apply_unary(&ma, |x| {
let data: Vec<f64> = x.iter().map(|v| v * 2.0).collect();
Array::from_vec(x.dim().clone(), data)
})
.unwrap();
assert!(result.has_real_mask());
assert_eq!(
result.mask().iter().copied().collect::<Vec<_>>(),
vec![false, true, false]
);
let d: Vec<f64> = result.data().iter().copied().collect();
assert_eq!(d[0], 2.0);
assert_eq!(d[1], 0.0); assert_eq!(d[2], 6.0);
}
#[test]
fn ma_apply_unary_generic_over_both_types() {
fn double_it<T, D, X>(x: &X) -> FerrayResult<MaskedArray<T, D>>
where
T: Element + Copy + std::ops::Mul<Output = T> + num_traits::FromPrimitive,
D: Dimension,
X: MaskAware<T, D>,
{
let two = T::from_f64(2.0).unwrap();
ma_apply_unary(x, move |a| {
let data: Vec<T> = a.iter().map(|v| *v * two).collect();
Array::from_vec(a.dim().clone(), data)
})
}
let plain = arr_f64(vec![1.0, 2.0, 3.0]);
let masked = ma_f64(vec![1.0, 2.0, 3.0], vec![false, true, false]);
let r_plain = double_it(&plain).unwrap();
let r_masked = double_it(&masked).unwrap();
assert!(!r_plain.has_real_mask());
assert_eq!(
r_plain.data().iter().copied().collect::<Vec<_>>(),
vec![2.0, 4.0, 6.0]
);
assert!(r_masked.has_real_mask());
assert_eq!(
r_masked.mask().iter().copied().collect::<Vec<_>>(),
vec![false, true, false]
);
}
#[test]
fn ma_apply_unary_rejects_shape_changing_function() {
let a = arr_f64(vec![1.0, 2.0, 3.0]);
let result = ma_apply_unary(&a, |_| {
Ok(arr_f64(vec![1.0, 2.0]))
});
assert!(result.is_err());
}
}