1 //================================================================================================= 2 /*! 3 // \file blaze/math/StorageOrder.h 4 // \brief Header file for the matrix storage order 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_STORAGEORDER_H_ 36 #define _BLAZE_MATH_STORAGEORDER_H_ 37 38 39 namespace blaze { 40 41 //================================================================================================= 42 // 43 // MATRIX STORAGE ORDER TYPES 44 // 45 //================================================================================================= 46 47 //************************************************************************************************* 48 /*!\brief Storage order flag for row-major matrices. 49 // 50 // Via this flag it is possible to specify the storage order of matrices as row-major. For 51 // instance, given the following matrix 52 53 \f[\left(\begin{array}{*{3}{c}} 54 1 & 2 & 3 \\ 55 4 & 5 & 6 \\ 56 \end{array}\right)\f]\n 57 58 // in case of row-major order the elements are stored in the order 59 60 \f[\left(\begin{array}{*{6}{c}} 61 1 & 2 & 3 & 4 & 5 & 6. \\ 62 \end{array}\right)\f] 63 64 // The following example demonstrates the setup of this \f$ 2 \times 3 \f$ matrix: 65 66 \code 67 using blaze::rowMajor; 68 blaze::StaticMatrix<int,2UL,3UL,rowMajor> A( { { 1, 2, 3 }, { 4, 5, 6 } } ); 69 \endcode 70 */ 71 constexpr bool rowMajor = false; 72 //************************************************************************************************* 73 74 75 //************************************************************************************************* 76 /*!\brief Storage order flag for column-major matrices. 77 // 78 // Via this flag it is possible to specify the storage order of matrices as column-major. For 79 // instance, given the following matrix 80 81 \f[\left(\begin{array}{*{3}{c}} 82 1 & 2 & 3 \\ 83 4 & 5 & 6 \\ 84 \end{array}\right)\f]\n 85 86 // in case of column-major order the elements are stored in the order 87 88 \f[\left(\begin{array}{*{6}{c}} 89 1 & 4 & 2 & 5 & 3 & 6. \\ 90 \end{array}\right)\f] 91 92 // The following example demonstrates the setup of this \f$ 2 \times 3 \f$ matrix: 93 94 \code 95 using blaze::columnMajor; 96 blaze::StaticMatrix<int,2UL,3UL,columnMajor> A( { { 1, 2, 3 }, { 4, 5, 6 } } ); 97 \endcode 98 */ 99 constexpr bool columnMajor = true; 100 //************************************************************************************************* 101 102 } // namespace blaze 103 104 #endif 105