1 //=================================================================================================
2 /*!
3 //  \file blaze/math/constraints/StorageOrder.h
4 //  \brief Constraints on the storage order of matrix types
5 //
6 //  Copyright (C) 2012-2020 Klaus Iglberger - All Rights Reserved
7 //
8 //  This file is part of the Blaze library. You can redistribute it and/or modify it under
9 //  the terms of the New (Revised) BSD License. Redistribution and use in source and binary
10 //  forms, with or without modification, are permitted provided that the following conditions
11 //  are met:
12 //
13 //  1. Redistributions of source code must retain the above copyright notice, this list of
14 //     conditions and the following disclaimer.
15 //  2. Redistributions in binary form must reproduce the above copyright notice, this list
16 //     of conditions and the following disclaimer in the documentation and/or other materials
17 //     provided with the distribution.
18 //  3. Neither the names of the Blaze development group nor the names of its contributors
19 //     may be used to endorse or promote products derived from this software without specific
20 //     prior written permission.
21 //
22 //  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
23 //  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 //  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
25 //  SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 //  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
27 //  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28 //  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 //  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 //  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
31 //  DAMAGE.
32 */
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_CONSTRAINTS_STORAGEORDER_H_
36 #define _BLAZE_MATH_CONSTRAINTS_STORAGEORDER_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <blaze/math/typetraits/IsMatrix.h>
44 #include <blaze/math/typetraits/StorageOrder.h>
45 
46 
47 namespace blaze {
48 
49 //=================================================================================================
50 //
51 //  MUST_BE_MATRIX_WITH_STORAGE_ORDER CONSTRAINT
52 //
53 //=================================================================================================
54 
55 //*************************************************************************************************
56 /*!\brief Constraint on the data type.
57 // \ingroup math_constraints
58 //
59 // In case the given data type \a T is not a dense or sparse matrix type and in case the
60 // storage order of the given dense or sparse vector type \a T is not set to \a SO, a
61 // compilation error is created.
62 */
63 #define BLAZE_CONSTRAINT_MUST_BE_MATRIX_WITH_STORAGE_ORDER(T,SO) \
64    static_assert( ::blaze::IsMatrix_v<T> && \
65                   ::blaze::StorageOrder_v<T> == SO, "Invalid storage order detected" )
66 //*************************************************************************************************
67 
68 
69 
70 
71 //=================================================================================================
72 //
73 //  MATRICES_MUST_HAVE_SAME_STORAGE_ORDER CONSTRAINT
74 //
75 //=================================================================================================
76 
77 //*************************************************************************************************
78 /*!\brief Constraint on the data type.
79 // \ingroup math_constraints
80 //
81 // In case either of the two given data types \a T1 or \a T2 is not a matrix type and in case
82 // the storage order of both matrix types doesn't match, a compilation error is created.
83 */
84 #define BLAZE_CONSTRAINT_MATRICES_MUST_HAVE_SAME_STORAGE_ORDER(T1,T2) \
85    static_assert( ::blaze::IsMatrix_v<T1> && \
86                   ::blaze::IsMatrix_v<T2> && \
87                   ::blaze::StorageOrder_v<T1> == ::blaze::StorageOrder_v<T2>, "Invalid storage order failed" )
88 //*************************************************************************************************
89 
90 
91 
92 
93 //=================================================================================================
94 //
95 //  MATRICES_MUST_HAVE_DIFFERENT_STORAGE_ORDER CONSTRAINT
96 //
97 //=================================================================================================
98 
99 //*************************************************************************************************
100 /*!\brief Constraint on the data type.
101 // \ingroup math_constraints
102 //
103 // In case either of the two given data types \a T1 or \a T2 is not a matrix type and in case
104 // the storage order of both matrix types does match, a compilation error is created.
105 */
106 #define BLAZE_CONSTRAINT_MATRICES_MUST_HAVE_DIFFERENT_STORAGE_ORDER(T1,T2) \
107    static_assert( ::blaze::IsMatrix_v<T1> && \
108                   ::blaze::IsMatrix_v<T2> && \
109                   ::blaze::StorageOrder_v<T1> != ::blaze::StorageOrder_v<T2>, "Invalid storage order detected" )
110 //*************************************************************************************************
111 
112 } // namespace blaze
113 
114 #endif
115