1 //================================================================================================= 2 /*! 3 // \file blaze/math/AlignmentFlag.h 4 // \brief Header file for the alignment flag enumeration 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_ALIGNMENTFLAG_H_ 36 #define _BLAZE_MATH_ALIGNMENTFLAG_H_ 37 38 39 namespace blaze { 40 41 //================================================================================================= 42 // 43 // ALIGNMENT FLAG 44 // 45 //================================================================================================= 46 47 //************************************************************************************************* 48 /*!\brief Alignment flag for (un-)aligned vectors and matrices. 49 // \ingroup math 50 // 51 // Via these flags it is possible to specify subvectors, submatrices, custom vectors and matrices 52 // as unaligned or aligned. The following example demonstrates the setup of an unaligned subvector: 53 54 \code 55 using blaze::columnVector; 56 using blaze::unaligned; 57 58 blaze::DynamicVector<int,columnVector> v( 100UL ); 59 auto sv = subvector<unaligned>( v, 10UL, 20UL ); 60 \endcode 61 */ 62 enum AlignmentFlag : bool 63 { 64 unaligned = false, //!< Flag for unaligned vectors and matrices. 65 aligned = true //!< Flag for aligned vectors and matrices. 66 }; 67 //************************************************************************************************* 68 69 70 //************************************************************************************************* 71 /*!\brief Negating the given alignment flag. 72 // \ingroup math 73 // 74 // \param flag The given alignment flag to be negated. 75 // \return The negated alignment flag. 76 // 77 // This logical NOT operator negates the given alignment flag. In case the given flag represents 78 // \a unaligned, the function returns \a aligned, in case it represents \a aligned it returns 79 // \a unaligned. 80 */ 81 constexpr AlignmentFlag operator!( AlignmentFlag flag ) noexcept 82 { 83 return static_cast<AlignmentFlag>( !static_cast<bool>( flag ) ); 84 } 85 //************************************************************************************************* 86 87 } // namespace blaze 88 89 #endif 90