Blaze 3.9
Typedefs | Variables
ReductionFlag.h File Reference

Header file for the reduction flags. More...

#include <blaze/util/Types.h>

Go to the source code of this file.

Typedefs

using blaze::ReductionFlag = size_t
 Type of the reduction flags.
 

Variables

constexpr ReductionFlag blaze::rowwise = 1UL
 Reduction flag for row-wise reduction operations. More...
 
constexpr ReductionFlag blaze::columnwise = 0UL
 Reduction flag for column-wise reduction operations. More...
 

Detailed Description

Header file for the reduction flags.

Copyright (C) 2012-2020 Klaus Iglberger - All Rights Reserved

This file is part of the Blaze library. You can redistribute it and/or modify it under the terms of the New (Revised) BSD License. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the names of the Blaze development group nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Variable Documentation

◆ columnwise

constexpr ReductionFlag blaze::columnwise = 0UL
constexpr

Reduction flag for column-wise reduction operations.

This flag can be used to perform column-wise reduction operations on matrices. The following example shows the column-wise summation of a column-major matrix:

blaze::DynamicMatrix<int,columnMajor> A{ { 4, 1, 2 }, { -2, 0, 3 } };
v = sum<columnwise>( A ); // Results in ( 2, 1, 5 )
Efficient implementation of a dynamic matrix.
Definition: DynamicMatrix.h:242
Efficient implementation of an arbitrary sized vector.
Definition: DynamicVector.h:223
constexpr bool columnMajor
Storage order flag for column-major matrices.
Definition: StorageOrder.h:99
constexpr bool rowVector
Transpose flag for row vectors.
Definition: TransposeFlag.h:73

◆ rowwise

constexpr ReductionFlag blaze::rowwise = 1UL
constexpr

Reduction flag for row-wise reduction operations.

This flag can be used to perform row-wise reduction operations on matrices. The following example shows the row-wise summation of a row-major matrix:

blaze::DynamicMatrix<int,rowMajor> A{ { 4, 1, 2 }, { -2, 0, 3 } };
v = sum<rowwise>( A ); // Results in ( 7, 1 )
constexpr bool rowMajor
Storage order flag for row-major matrices.
Definition: StorageOrder.h:71
constexpr bool columnVector
Transpose flag for column vectors.
Definition: TransposeFlag.h:58