op_macros.rs - source
Description: Source of the Rust file `/Users/erlendbasso/.cargo/registry/src/github.com-1ecc6299db9ec823/nalgebra-0.32.1/src/geometry/op_macros.rs`.
Keywords: rust, rustlang, rust-lang

    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
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209

    #![macro_use]

    // TODO: merge with `md_impl`.
    /// Macro for the implementation of multiplication and division.
    macro_rules! md_impl(
        (
        // Operator, operator method, and scalar bounds.
         $Op: ident, $op: ident $(where T: $($ScalarBounds: ident),*)*;
         // Storage dimensions, and dimension bounds.
         ($R1: ty, $C1: ty),($R2: ty, $C2: ty)
         // Const type declaration
         const $($D: ident),*;
         // Other generic type declarations.
         for $($DimsDecl: ident),*;
         // Where clause.
         where $($ConstraintType: ty: $ConstraintBound: ident$(<$($ConstraintBoundParams: ty $( = $EqBound: ty )*),*>)*),*;
         // Argument identifiers and types + output.
         $lhs: ident: $Lhs: ty, $rhs: ident: $Rhs: ty, Output = $Result: ty;
         // Operator actual implementation.
         $action: expr;
         // Lifetime.
         $($lives: tt),*) => {
            impl<$($lives ,)* T $(, $DimsDecl)* $(, const $D: usize)*> $Op<$Rhs> for $Lhs
                where T: Scalar + Zero + One + ClosedAdd + ClosedMul $($(+ $ScalarBounds)*)*,
                      $( $ConstraintType: $ConstraintBound$(<$( $ConstraintBoundParams $( = $EqBound )*),*>)* ),*
                       {
                type Output = $Result;

                #[inline]
                fn $op($lhs, $rhs: $Rhs) -> Self::Output {
                    $action
                }
            }
        }
    );

    /// Macro for the implementation of multiplication and division.
    /// Implements all the argument reference combinations.
    macro_rules! md_impl_all(
        (
         // Operator, operator method, and scalar bounds.
         $Op: ident, $op: ident $(where T: $($ScalarBounds: ident),*)*;
         // Storage dimensions, and dimension bounds.
         ($R1: ty, $C1: ty),($R2: ty, $C2: ty)
         // Const type declaration
         const $($D: ident),*;
         // Other generic type declarations.
         for $($DimsDecl: ident),*;
         // Where clause.
         where $($ConstraintType: ty: $ConstraintBound: ident$(<$($ConstraintBoundParams: ty $( = $EqBound: ty )*),*>)*),*;
         // Argument identifiers and types + output.
         $lhs: ident: $Lhs: ty, $rhs: ident: $Rhs: ty, Output = $Result: ty;
         // Operators actual implementations.
         [val val] => $action_val_val: expr;
         [ref val] => $action_ref_val: expr;
         [val ref] => $action_val_ref: expr;
         [ref ref] => $action_ref_ref: expr;) => {

            md_impl!(
                $Op, $op $(where T: $($ScalarBounds),*)*;
                ($R1, $C1),($R2, $C2)
                const $($D),*;
                for $($DimsDecl),*;
                where $($ConstraintType: $ConstraintBound$(<$($ConstraintBoundParams $( = $EqBound )*),*>)*),*;
                $lhs: $Lhs, $rhs: $Rhs, Output = $Result;
                $action_val_val; );

            md_impl!(
                $Op, $op $(where T: $($ScalarBounds),*)*;
                ($R1, $C1),($R2, $C2)
                const $($D),*;
                for $($DimsDecl),*;
                where $($ConstraintType: $ConstraintBound$(<$($ConstraintBoundParams $( = $EqBound )*),*>)*),*;
                $lhs: &'a $Lhs, $rhs: $Rhs, Output = $Result;
                $action_ref_val; 'a);

            md_impl!(
                $Op, $op $(where T: $($ScalarBounds),*)*;
                ($R1, $C1),($R2, $C2)
                const $($D),*;
                for $($DimsDecl),*;
                where $($ConstraintType: $ConstraintBound$(<$($ConstraintBoundParams $( = $EqBound )*),*>)*),*;
                $lhs: $Lhs, $rhs: &'b $Rhs, Output = $Result;
                $action_val_ref; 'b);

            md_impl!(
                $Op, $op $(where T: $($ScalarBounds),*)*;
                ($R1, $C1),($R2, $C2)
                const $($D),*;
                for $($DimsDecl),*;
                where $($ConstraintType: $ConstraintBound$(<$($ConstraintBoundParams $( = $EqBound )*),*>)*),*;
                $lhs: &'a $Lhs, $rhs: &'b $Rhs, Output = $Result;
                $action_ref_ref; 'a, 'b);
        }
    );

    /// Macro for the implementation of assignment-multiplication and assignment-division.
    macro_rules! md_assign_impl(
        (
         // Operator, operator method, and scalar bounds.
         $Op: ident, $op: ident $(where T: $($ScalarBounds: ident),*)* $(for T::Element: $($ElementBounds: ident),*)*;
         // Storage dimensions, and dimension bounds.
         ($R1: ty, $C1: ty),($R2: ty, $C2: ty)
         // Const type declaration
         const $($D: ident),*;
         // Other generic type declarations.
         for $($DimsDecl: ident),*;
         // Where clause.
         where $($ConstraintType: ty: $ConstraintBound: ident$(<$($ConstraintBoundParams: ty $( = $EqBound: ty )*),*>)*),*;
         // Argument identifiers and types.
         $lhs: ident: $Lhs: ty, $rhs: ident: $Rhs: ty;
         // Actual implementation and lifetimes.
         $action: expr; $($lives: tt),*) => {
            impl<$($lives ,)* T $(, $DimsDecl)* $(, const $D: usize)*> $Op<$Rhs> for $Lhs
                where T: Scalar + Zero + One + ClosedAdd + ClosedMul $($(+ $ScalarBounds)*)*,
                      $($(T::Element: $ElementBounds,)*)*
                      $( $ConstraintType: $ConstraintBound $(<$( $ConstraintBoundParams $( = $EqBound )*),*>)* ),*
            {
                #[inline]
                fn $op(&mut $lhs, $rhs: $Rhs) {
                    $action
                }
            }
        }
    );

    /// Macro for the implementation of assignment-multiplication and assignment-division with and
    /// without reference to the right-hand-side.
    macro_rules! md_assign_impl_all(
        (
         // Operator, operator method, and scalar bounds.
         $Op: ident, $op: ident $(where T: $($ScalarBounds: ident),*)* $(for T::Element: $($ElementBounds: ident),*)*;
         // Storage dimensions, and dimension bounds.
         ($R1: ty, $C1: ty),($R2: ty, $C2: ty)
         // Const type declaration
         const $($D: ident),*;
         // Other generic type declarations.
         for $($DimsDecl: ident),*;
         // Where clause.
         where $($ConstraintType: ty: $ConstraintBound: ident$(<$($ConstraintBoundParams: ty $( = $EqBound: ty )*),*>)*),*;
         // Argument identifiers and types.
         $lhs: ident: $Lhs: ty, $rhs: ident: $Rhs: ty;
         // Actual implementation and lifetimes.
         [val] => $action_val: expr;
         [ref] => $action_ref: expr;) => {
            md_assign_impl!(
                $Op, $op $(where T: $($ScalarBounds),*)* $(for T::Element: $($ElementBounds),*)*;
                ($R1, $C1),($R2, $C2)
                const $($D),*;
                for $($DimsDecl),*;
                where $($ConstraintType: $ConstraintBound$(<$($ConstraintBoundParams $( = $EqBound )*),*>)*),*;
                $lhs: $Lhs, $rhs: $Rhs;
                $action_val; );

            md_assign_impl!(
                $Op, $op $(where T: $($ScalarBounds),*)* $(for T::Element: $($ElementBounds),*)*;
                ($R1, $C1),($R2, $C2)
                const $($D),*;
                for $($DimsDecl),*;
                where $($ConstraintType: $ConstraintBound$(<$($ConstraintBoundParams $( = $EqBound )*),*>)*),*;
                $lhs: $Lhs, $rhs: &'b $Rhs;
                $action_ref; 'b);
        }
    );

    // TODO: merge with `as_impl`.
    /// Macro for the implementation of addition and subtraction.
    macro_rules! add_sub_impl(
        ($Op: ident, $op: ident, $bound: ident;
         ($R1: ty, $C1: ty),($R2: ty, $C2: ty) $(-> ($RRes: ty, $CRes: ty))*
         // Const type declaration
         const $($D: ident),*;
         // Other generic type declarations.
         for $($DimsDecl: ident),*;
         // Where clause.
         where $($ConstraintType: ty: $ConstraintBound: ident$(<$($ConstraintBoundParams: ty $( = $EqBound: ty )*),*>)*),*;
         $lhs: ident: $Lhs: ty, $rhs: ident: $Rhs: ty, Output = $Result: ty;
         $action: expr; $($lives: tt),*) => {
            impl<$($lives ,)* T $(, $DimsDecl)* $(, const $D: usize)*> $Op<$Rhs> for $Lhs
                where T: Scalar + $bound,
                      ShapeConstraint: SameNumberOfRows<$R1, $R2 $(, Representative = $RRes)*> +
                                       SameNumberOfColumns<$C1, $C2 $(, Representative = $CRes)*>,
                      $( $ConstraintType: $ConstraintBound$(<$( $ConstraintBoundParams $( = $EqBound )*),*>)* ),* {
                type Output = $Result;

                #[inline]
                fn $op($lhs, $rhs: $Rhs) -> Self::Output {
                    $action
                }
            }
        }
    );

    // TODO: merge with `md_assign_impl`.
    /// Macro for the implementation of assignment-addition and assignment-subtraction.
    macro_rules! add_sub_assign_impl(
        ($Op: ident, $op: ident, $bound: ident;
        $(const $D: ident),*;
         $lhs: ident: $Lhs: ty, $rhs: ident: $Rhs: ty;
         $action: expr; $($lives: tt),*) => {
            impl<$($lives ,)* T $(, const $D: usize),*> $Op<$Rhs> for $Lhs
                where T: Scalar + $bound {
                #[inline]
                fn $op(&mut $lhs, $rhs: $Rhs) {
                    $action
                }
            }
        }
    );