glam_det 2.0.0-beta.3

// Copyright (C) 2020-2025 glam-det authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Generated from mat.rs.tera template. Edit the template, not the generated file.

use crate::{
    nums::{bool32x4, f32x4, num_traits::*},
    swizzles::*,
    Mat2, Mat3x4, UnitVec2x4, Vec2x4,
};

use auto_ops_det::{impl_op_ex, impl_op_ex_commutative};
#[cfg(not(target_arch = "spirv"))]
use core::fmt;
use core::iter::{Product, Sum};
use core::ops::{self, Add, Mul, Neg, Sub};

/// Creates a 2x2 matrix from column vectors.
#[inline]
pub const fn mat2x4(x_axis: Vec2x4, y_axis: Vec2x4) -> Mat2x4 {
    Mat2x4::from_cols(x_axis, y_axis)
}

/// A 2x2 column major matrix.
#[derive(Clone, Copy)]
#[repr(C)]
pub struct Mat2x4 {
    pub x_axis: Vec2x4,
    pub y_axis: Vec2x4,
}

impl Mat2x4 {
    /// A 2x2 matrix with all elements set to `0.0`.
    pub const ZERO: Self = Self::from_cols(Vec2x4::ZERO, Vec2x4::ZERO);

    /// A 2x2 identity matrix, where all diagonal elements are `1`, and all off-diagonal elements are `0`.
    pub const IDENTITY: Self = Self::from_cols(Vec2x4::X, Vec2x4::Y);

    /// All NAN:s.
    pub const NAN: Self = Self::from_cols(Vec2x4::NAN, Vec2x4::NAN);

    #[allow(clippy::too_many_arguments)]
    #[inline]
    const fn new(m00: f32x4, m01: f32x4, m10: f32x4, m11: f32x4) -> Self {
        Self {
            x_axis: Vec2x4::new(m00, m01),
            y_axis: Vec2x4::new(m10, m11),
        }
    }

    /// Select lanes from two SOA `Mat2x4` to compose a new SOA `Mat2x4`.
    #[inline]
    pub fn lane_select(cond: bool32x4, if_true: Self, if_false: Self) -> Self {
        Self {
            x_axis: Vec2x4::lane_select(cond, if_true.x_axis, if_false.x_axis),
            y_axis: Vec2x4::lane_select(cond, if_true.y_axis, if_false.y_axis),
        }
    }

    /// Create a SOA `Mat2x4` with all lanes set to `m`.
    #[inline]
    pub fn splat_soa(m: Mat2) -> Self {
        Self {
            x_axis: Vec2x4::splat_soa(m.x_axis),
            y_axis: Vec2x4::splat_soa(m.y_axis),
        }
    }

    /// Extract a single lane from a SOA `Mat2x4`.
    ///
    /// # Panics
    ///
    /// Panics if `i` is larger than 3.
    #[inline]
    pub fn extract_lane(&self, i: usize) -> Mat2 {
        Mat2::from_cols(self.x_axis.extract_lane(i), self.y_axis.extract_lane(i))
    }

    /// Replace a single lane in a SOA `Mat2x4`.
    ///
    /// # Panics
    ///
    /// Panics if `i` is larger than 3.
    #[inline]
    pub fn replace_lane(&mut self, i: usize, m: Mat2) {
        self.x_axis.replace_lane(i, m.x_axis);
        self.y_axis.replace_lane(i, m.y_axis);
    }

    /// Split a SOA `Mat2x4` into 4 `Mat2`.
    #[inline]
    pub fn split_soa(self) -> [Mat2; 4] {
        [
            self.extract_lane(0),
            self.extract_lane(1),
            self.extract_lane(2),
            self.extract_lane(3),
        ]
    }

    /// Compose a SOA `Mat2x4` from 4 `Mat2`.
    #[inline]
    pub fn compose_soa(a: &[Mat2; 4]) -> Mat2x4 {
        let mut v = Self::default();
        v.replace_lane(0, a[0]);
        v.replace_lane(1, a[1]);
        v.replace_lane(2, a[2]);
        v.replace_lane(3, a[3]);
        v
    }

    /// Creates a 2x2 matrix from two column vectors.
    #[inline]
    pub const fn from_cols(x_axis: Vec2x4, y_axis: Vec2x4) -> Self {
        Self { x_axis, y_axis }
    }

    /// Creates a 2x2 matrix from a `[f32x4; 4]` array stored in column major order.
    /// If your data is stored in row major you will need to `transpose` the returned
    /// matrix.
    #[inline]
    pub const fn from_cols_array(m: &[f32x4; 4]) -> Self {
        Self::new(m[0], m[1], m[2], m[3])
    }

    /// Creates a `[f32x4; 4]` array storing data in column major order.
    /// If you require data in row major order `transpose` the matrix first.
    #[inline]
    pub fn to_cols_array(&self) -> [f32x4; 4] {
        [self.x_axis.x, self.x_axis.y, self.y_axis.x, self.y_axis.y]
    }

    /// Creates a 2x2 matrix from a `[[f32x4; 2]; 2]` 2D array stored in column major order.
    /// If your data is in row major order you will need to `transpose` the returned
    /// matrix.
    #[inline]
    pub const fn from_cols_array_2d(m: &[[f32x4; 2]; 2]) -> Self {
        Self::from_cols(Vec2x4::from_array(m[0]), Vec2x4::from_array(m[1]))
    }

    /// Creates a `[[f32x4; 2]; 2]` 2D array storing data in column major order.
    /// If you require data in row major order `transpose` the matrix first.
    #[inline]
    pub fn to_cols_array_2d(&self) -> [[f32x4; 2]; 2] {
        [self.x_axis.to_array(), self.y_axis.to_array()]
    }

    /// Creates a 2x2 matrix with its diagonal set to `diagonal` and all other entries set to 0.
    #[doc(alias = "scale")]
    #[inline]
    pub fn from_diagonal(diagonal: Vec2x4) -> Self {
        Self::new(diagonal.x, f32x4::ZERO, f32x4::ZERO, diagonal.y)
    }

    /// Creates a 2x2 matrix containing the combining non-uniform `scale` and rotation of
    /// `angle` (in radians).
    #[inline]
    pub fn from_scale_angle(scale: Vec2x4, angle: f32x4) -> Self {
        let (sin, cos) = angle.sin_cosf();
        Self::new(cos * scale.x, sin * scale.x, -sin * scale.y, cos * scale.y)
    }

    /// Creates a 2x2 matrix containing a rotation of `angle` (in radians).
    #[inline]
    pub fn from_angle(angle: f32x4) -> Self {
        let (sin, cos) = angle.sin_cosf();
        Self::new(cos, sin, -sin, cos)
    }

    /// Creates a 2x2 matrix from a 3x3 matrix, discarding the 2nd row and column.
    #[inline]
    pub fn from_mat3(m: Mat3x4) -> Self {
        Self::from_cols(m.x_axis.xy(), m.y_axis.xy())
    }

    /// Creates a 2x2 matrix from the first 4 values in `slice`.
    ///
    /// # Panics
    ///
    /// Panics if `slice` is less than 4 elements long.
    #[inline]
    pub const fn from_cols_slice(slice: &[f32x4]) -> Self {
        Self::new(slice[0], slice[1], slice[2], slice[3])
    }

    /// Writes the columns of `self` to the first 4 elements in `slice`.
    ///
    /// # Panics
    ///
    /// Panics if `slice` is less than 4 elements long.
    #[inline]
    pub fn write_cols_to_slice(self, slice: &mut [f32x4]) {
        slice[0] = self.x_axis.x;
        slice[1] = self.x_axis.y;
        slice[2] = self.y_axis.x;
        slice[3] = self.y_axis.y;
    }

    /// Returns the matrix column for the given `index`.
    ///
    /// # Panics
    ///
    /// Panics if `index` is greater than 1.
    #[inline]
    pub fn col(&self, index: usize) -> Vec2x4 {
        match index {
            0 => self.x_axis,
            1 => self.y_axis,
            _ => panic!("index out of bounds"),
        }
    }

    /// Returns a mutable reference to the matrix column for the given `index`.
    ///
    /// # Panics
    ///
    /// Panics if `index` is greater than 1.
    #[inline]
    pub fn col_mut(&mut self, index: usize) -> &mut Vec2x4 {
        match index {
            0 => &mut self.x_axis,
            1 => &mut self.y_axis,
            _ => panic!("index out of bounds"),
        }
    }

    /// Returns the matrix row for the given `index`.
    ///
    /// # Panics
    ///
    /// Panics if `index` is greater than 1.
    #[inline]
    pub fn row(&self, index: usize) -> Vec2x4 {
        match index {
            0 => Vec2x4::new(self.x_axis.x, self.y_axis.x),
            1 => Vec2x4::new(self.x_axis.y, self.y_axis.y),
            _ => panic!("index out of bounds"),
        }
    }

    /// Returns `true` if, and only if, all elements are finite.
    /// If any element is either `NaN`, positive or negative infinity, this will return `false`.
    #[inline]
    pub fn is_finite(&self) -> bool32x4 {
        self.x_axis.is_finite() & self.y_axis.is_finite()
    }

    /// Returns `true` if any elements are `NaN`.
    #[inline]
    pub fn is_nan(&self) -> bool32x4 {
        self.x_axis.is_nan() | self.y_axis.is_nan()
    }

    /// Returns the transpose of `self`.
    #[must_use]
    #[inline]
    pub fn transpose(&self) -> Self {
        Self {
            x_axis: Vec2x4::new(self.x_axis.x, self.y_axis.x),
            y_axis: Vec2x4::new(self.x_axis.y, self.y_axis.y),
        }
    }

    /// Returns the determinant of `self`.
    #[inline]
    pub fn determinant(&self) -> f32x4 {
        self.x_axis.x * self.y_axis.y - self.x_axis.y * self.y_axis.x
    }

    /// Returns the inverse of `self`.
    ///
    /// If the matrix is not invertible the returned matrix will be invalid.
    ///
    /// # Panics
    ///
    /// Will panic if the determinant of `self` is zero when `glam_assert` is enabled.
    #[must_use]
    #[inline]
    pub fn inverse(&self) -> Self {
        let inv_det = {
            let det = self.determinant();
            glam_assert!(det.ne(f32x4::ZERO));
            det.recip()
        };
        Self::new(
            self.y_axis.y * inv_det,
            self.x_axis.y * -inv_det,
            self.y_axis.x * -inv_det,
            self.x_axis.x * inv_det,
        )
    }

    /// Transforms a 2D vector.
    #[inline]
    pub fn mul_vec2(&self, rhs: Vec2x4) -> Vec2x4 {
        #[allow(clippy::suspicious_operation_groupings)]
        Vec2x4::new(
            (self.x_axis.x * rhs.x) + (self.y_axis.x * rhs.y),
            (self.x_axis.y * rhs.x) + (self.y_axis.y * rhs.y),
        )
    }

    /// Multiplies two 2x2 matrices.
    #[inline]
    pub fn mul_mat2(&self, rhs: &Self) -> Self {
        Self::from_cols(self.mul(rhs.x_axis), self.mul(rhs.y_axis))
    }

    /// Adds two 2x2 matrices.
    #[inline]
    pub fn add_mat2(&self, rhs: &Self) -> Self {
        Self::from_cols(self.x_axis.add(rhs.x_axis), self.y_axis.add(rhs.y_axis))
    }

    /// Subtracts two 2x2 matrices.
    #[inline]
    pub fn sub_mat2(&self, rhs: &Self) -> Self {
        Self::from_cols(self.x_axis.sub(rhs.x_axis), self.y_axis.sub(rhs.y_axis))
    }

    /// Multiplies a 2x2 matrix by a scalar.
    #[inline]
    pub fn mul_scalar(&self, rhs: f32x4) -> Self {
        Self::from_cols(self.x_axis.mul(rhs), self.y_axis.mul(rhs))
    }

    /// Returns true if the absolute difference of all elements between `self` and `rhs`
    /// is less than or equal to `max_abs_diff`.
    ///
    /// This can be used to compare if two matrices contain similar elements. It works best
    /// when comparing with a known value. The `max_abs_diff` that should be used used
    /// depends on the values being compared against.
    ///
    /// For more see
    /// [comparing floating point numbers](https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/).
    #[inline]
    pub fn abs_diff_eq(&self, rhs: Self, max_abs_diff: f32x4) -> bool32x4 {
        self.x_axis.abs_diff_eq(rhs.x_axis, max_abs_diff)
            & self.y_axis.abs_diff_eq(rhs.y_axis, max_abs_diff)
    }
}

impl Default for Mat2x4 {
    #[inline]
    fn default() -> Self {
        Self::IDENTITY
    }
}

impl_op_ex!(+ |a: &Mat2x4, b:&Mat2x4| -> Mat2x4 { a.add_mat2(b) });
impl_op_ex!(+= |a: &mut Mat2x4, b:&Mat2x4| { *a = a.add_mat2(b); });

impl_op_ex!(-|a: &Mat2x4, b: &Mat2x4| -> Mat2x4 { a.sub_mat2(b) });
impl_op_ex!(-= |a: &mut Mat2x4, b:&Mat2x4| { *a = a.sub_mat2(b); });

impl Neg for Mat2x4 {
    type Output = Self;
    #[inline]
    fn neg(self) -> Self::Output {
        Self::from_cols(self.x_axis.neg(), self.y_axis.neg())
    }
}

impl_op_ex!(*|a: &Mat2x4, b: &Mat2x4| -> Mat2x4 { a.mul_mat2(b) });
impl_op_ex!(*= |a: &mut Mat2x4, b:&Mat2x4| { *a = a.mul_mat2(b); });

impl_op_ex!(*|a: &Mat2x4, b: &Vec2x4| -> Vec2x4 { a.mul_vec2(*b) });

impl_op_ex!(*|a: &Mat2x4, b: &UnitVec2x4| -> Vec2x4 { a * b.as_vec2x4() });

impl_op_ex_commutative!(*|a: &Mat2x4, b: f32x4| -> Mat2x4 { a.mul_scalar(b) });
impl_op_ex!(*= |a: &mut Mat2x4, b:f32x4| { *a = a.mul_scalar(b); });

impl<'a> Sum<&'a Self> for Mat2x4 {
    fn sum<I>(iter: I) -> Self
    where
        I: Iterator<Item = &'a Self>,
    {
        iter.fold(Self::ZERO, |a, &b| Self::add(a, b))
    }
}

impl<'a> Product<&'a Self> for Mat2x4 {
    fn product<I>(iter: I) -> Self
    where
        I: Iterator<Item = &'a Self>,
    {
        iter.fold(Self::IDENTITY, |a, &b| Self::mul(a, b))
    }
}

impl PartialEq for Mat2x4 {
    #[inline]
    fn eq(&self, rhs: &Self) -> bool {
        self.x_axis.eq(&rhs.x_axis) && self.y_axis.eq(&rhs.y_axis)
    }
}

#[cfg(not(target_arch = "spirv"))]
impl AsRef<[f32x4; 4]> for Mat2x4 {
    #[inline]
    fn as_ref(&self) -> &[f32x4; 4] {
        unsafe { &*(self as *const Self as *const [f32x4; 4]) }
    }
}

#[cfg(not(target_arch = "spirv"))]
impl AsMut<[f32x4; 4]> for Mat2x4 {
    #[inline]
    fn as_mut(&mut self) -> &mut [f32x4; 4] {
        unsafe { &mut *(self as *mut Self as *mut [f32x4; 4]) }
    }
}

#[cfg(not(target_arch = "spirv"))]
impl fmt::Debug for Mat2x4 {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.debug_struct(stringify!(Mat2x4))
            .field("x_axis", &self.x_axis)
            .field("y_axis", &self.y_axis)
            .finish()
    }
}

#[cfg(not(target_arch = "spirv"))]
impl fmt::Display for Mat2x4 {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "[{}, {}]", self.x_axis, self.y_axis)
    }
}