Blaze 3.9
Classes
Vector.h File Reference

Header file for the Vector CRTP base class. More...

#include <blaze/math/Exception.h>
#include <blaze/math/typetraits/IsClearable.h>
#include <blaze/math/typetraits/IsResizable.h>
#include <blaze/math/typetraits/IsShrinkable.h>
#include <blaze/math/typetraits/IsZero.h>
#include <blaze/system/Inline.h>
#include <blaze/system/MacroDisable.h>
#include <blaze/util/Assert.h>
#include <blaze/util/EnableIf.h>
#include <blaze/util/FunctionTrace.h>
#include <blaze/util/IntegralConstant.h>
#include <blaze/util/MaybeUnused.h>
#include <blaze/util/Types.h>
#include <blaze/util/typetraits/IsSame.h>

Go to the source code of this file.

Classes

class  blaze::Vector< VT, TF >
 Base class for N-dimensional vectors. More...
 

Functions

Vector global functions
template<typename VT , bool TF>
VT & blaze::crtp_cast (Vector< VT, TF > &vector)
 CRTP-based conversion operation for non-constant vectors. More...
 
template<typename VT , bool TF>
const VT & blaze::crtp_cast (const Vector< VT, TF > &vector)
 CRTP-based conversion operation for constant vectors. More...
 
template<typename VT , bool TF>
VT::Iterator blaze::begin (Vector< VT, TF > &vector)
 Returns an iterator to the first element of the given vector. More...
 
template<typename VT , bool TF>
VT::ConstIterator blaze::begin (const Vector< VT, TF > &vector)
 Returns an iterator to the first element of the given vector. More...
 
template<typename VT , bool TF>
VT::ConstIterator blaze::cbegin (const Vector< VT, TF > &vector)
 Returns an iterator to the first element of the given vector. More...
 
template<typename VT , bool TF>
VT::Iterator blaze::end (Vector< VT, TF > &vector)
 Returns an iterator just past the last element of the given vector. More...
 
template<typename VT , bool TF>
VT::ConstIterator blaze::end (const Vector< VT, TF > &vector)
 Returns an iterator just past the last element of the given vector. More...
 
template<typename VT , bool TF>
VT::ConstIterator blaze::cend (const Vector< VT, TF > &vector)
 Returns an iterator just past the last element of the given vector. More...
 
template<typename VT , bool TF>
constexpr size_t blaze::size (const Vector< VT, TF > &vector) noexcept
 Returns the current size/dimension of the vector. More...
 
template<typename VT , bool TF>
size_t blaze::capacity (const Vector< VT, TF > &vector) noexcept
 Returns the maximum capacity of the vector. More...
 
template<typename VT , bool TF>
size_t blaze::nonZeros (const Vector< VT, TF > &vector)
 Returns the number of non-zero elements in the vector. More...
 
template<typename VT , bool TF>
constexpr void blaze::reset (Vector< VT, TF > &vector)
 Resetting the given vector. More...
 
template<typename VT , bool TF>
constexpr void blaze::reset (Vector< VT, TF > &&vector)
 Resetting the given temporary vector. More...
 
template<typename VT , bool TF>
constexpr void blaze::clear (Vector< VT, TF > &vector)
 Clearing the given vector. More...
 
template<typename VT , bool TF>
constexpr void blaze::clear (Vector< VT, TF > &&vector)
 Clearing the given temporary vector. More...
 
template<typename VT , bool TF>
void blaze::resize (Vector< VT, TF > &vector, size_t n, bool preserve=true)
 Changing the size of the vector. More...
 
template<typename VT , bool TF>
void blaze::shrinkToFit (Vector< VT, TF > &vector)
 Requesting the removal of unused capacity. More...
 
template<typename VT , bool TF>
VT::ResultType blaze::evaluate (const Vector< VT, TF > &vector)
 Evaluates the given vector expression. More...
 
template<bool B, typename VT , bool TF>
decltype(auto) blaze::evaluateIf (const Vector< VT, TF > &vector)
 Conditional evaluation of the given vector expression. More...
 
template<typename VT , bool TF>
constexpr bool blaze::isEmpty (const Vector< VT, TF > &vector) noexcept
 Checks if the given vector is empty. More...
 
template<typename VT1 , bool TF1, typename VT2 , bool TF2>
bool blaze::isSame (const Vector< VT1, TF1 > &a, const Vector< VT2, TF2 > &b) noexcept
 Returns whether the two given vectors represent the same observable state. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE VT & blaze::crtp_cast (Vector< VT, TF > &vector)
 CRTP-based conversion operation for non-constant vectors. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE const VT & blaze::crtp_cast (const Vector< VT, TF > &vector)
 CRTP-based conversion operation for constant vectors. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE VT::Iterator blaze::begin (Vector< VT, TF > &vector)
 Returns an iterator to the first element of the given vector. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE VT::ConstIterator blaze::begin (const Vector< VT, TF > &vector)
 Returns an iterator to the first element of the given vector. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE VT::ConstIterator blaze::cbegin (const Vector< VT, TF > &vector)
 Returns an iterator to the first element of the given vector. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE VT::Iterator blaze::end (Vector< VT, TF > &vector)
 Returns an iterator just past the last element of the given vector. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE VT::ConstIterator blaze::end (const Vector< VT, TF > &vector)
 Returns an iterator just past the last element of the given vector. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE VT::ConstIterator blaze::cend (const Vector< VT, TF > &vector)
 Returns an iterator just past the last element of the given vector. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE constexpr size_t blaze::size (const Vector< VT, TF > &vector) noexcept
 Returns the current size/dimension of the vector. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE size_t blaze::capacity (const Vector< VT, TF > &vector) noexcept
 Returns the maximum capacity of the vector. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE size_t blaze::nonZeros (const Vector< VT, TF > &vector)
 Returns the number of non-zero elements in the vector. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE void blaze::resize (Vector< VT, TF > &vector, size_t n, bool preserve)
 Changing the size of the vector. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE void blaze::shrinkToFit (Vector< VT, TF > &vector)
 Requesting the removal of unused capacity. More...
 
template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE constexpr bool blaze::isEmpty (const Vector< VT, TF > &vector) noexcept
 Checks if the given vector is empty. More...
 
template<typename VT1 , bool TF1, typename VT2 , bool TF2>
BLAZE_ALWAYS_INLINE bool blaze::isSame (const Vector< VT1, TF1 > &a, const Vector< VT2, TF2 > &b) noexcept
 Returns whether the two given vectors represent the same observable state. More...
 

Detailed Description

Header file for the Vector CRTP base class.

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.

Function Documentation

◆ crtp_cast() [1/4]

template<typename VT , bool TF>
const VT & blaze::crtp_cast ( const Vector< VT, TF > &  vector)

CRTP-based conversion operation for constant vectors.

Parameters
vectorThe vector to be downcast.
Returns
Const reference of the actual type of the vector.

This operator performs the CRTP-based type-safe downcast to the actual type VT of the vector. It will return a constant reference to the actual type VT.

◆ crtp_cast() [2/4]

template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE const VT & blaze::crtp_cast ( const Vector< VT, TF > &  vector)

CRTP-based conversion operation for constant vectors.

Parameters
vectorThe vector to be downcast.
Returns
Const reference of the actual type of the vector.

This operator performs the CRTP-based type-safe downcast to the actual type VT of the vector. It will return a constant reference to the actual type VT.

◆ crtp_cast() [3/4]

template<typename VT , bool TF>
VT & blaze::crtp_cast ( Vector< VT, TF > &  vector)

CRTP-based conversion operation for non-constant vectors.

Parameters
vectorThe vector to be downcast.
Returns
Mutable reference of the actual type of the vector.

This operator performs the CRTP-based type-safe downcast to the actual type VT of the vector. It will return a mutable reference to the actual type VT.

◆ crtp_cast() [4/4]

template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE VT & blaze::crtp_cast ( Vector< VT, TF > &  vector)

CRTP-based conversion operation for non-constant vectors.

Parameters
vectorThe vector to be downcast.
Returns
Mutable reference of the actual type of the vector.

This operator performs the CRTP-based type-safe downcast to the actual type VT of the vector. It will return a mutable reference to the actual type VT.