Boost C++ 库

...世界上最受推崇和专业设计的 C++ 库项目之一。 — Herb Sutter 和 Andrei Alexandrescu, C++ 编码标准

向量表达式

向量表达式

描述

模板类 vector_expression<E> 需要是所有对向量表达式概念建模的类的公共基类。

定义

定义于头文件 expression_types.hpp 中。

模板参数

参数 描述 默认值
E 向量表达式的类型。  

模型

无。不是向量表达式！

类型要求

无。

公共基类

无。

成员

成员 描述
const expression_type &operator () () const 返回表达式的 const 引用。
expression_type &operator () () 返回表达式的引用。

注释

range、slice 和 project 函数已被移除。请使用在 vector proxy 中定义的自由函数代替。

向量容器

描述

模板类 vector_container<C> 需要是所有对向量概念建模的类的公共基类。这包括类 vector 本身。

定义

定义于头文件 expression_types.hpp 中。

模板参数

参数 描述 默认值
C 向量容器的类型。  

模型

无。不是向量表达式或向量！

类型要求

无。

公共基类

vector_expression<C>

成员

成员 描述
const container_type &operator () () const 返回容器的 const 引用。
container_type &operator () () 返回容器的引用。

向量引用

引用

描述

模板类 vector_reference<E> 包含对向量表达式的引用。

定义

定义于头文件 vector_expression.hpp 中。

模板参数

参数 描述 默认值
E 向量表达式的类型。  

模型

向量表达式 .

类型要求

无，除了 向量表达式 的要求所施加的那些。

公共基类

vector_expression<vector_reference<E> >

成员

成员 描述
vector_reference (expression_type &e) 构造表达式的引用。
void resize (size_type size) 调整表达式大小以最多容纳 size 个元素。
size_type size () const 返回表达式的大小。
const_reference operator () (size_type i) const 返回第 i 个元素的值。
reference operator () (size_type i) 返回第 i 个元素的引用。
const_iterator begin () const 返回指向表达式开头的 const_iterator。
const_iterator end () const 返回指向表达式结尾的 const_iterator。
iterator begin () 返回指向表达式开头的 iterator。
iterator end () 返回指向表达式结尾的 iterator。
const_reverse_iterator rbegin () const 返回指向反向表达式开头的 const_reverse_iterator。
const_reverse_iterator rend () const 返回指向反向表达式结尾的 const_reverse_iterator。
reverse_iterator rbegin () 返回指向反向表达式开头的 reverse_iterator。
reverse_iterator rend () 返回指向反向表达式结尾的 reverse_iterator。

向量运算

一元运算描述

描述

模板类 vector_unary<E, F> 描述一元向量运算。

定义

定义于头文件 vector_expression.hpp 中。

模板参数

参数 描述 默认值
E 向量表达式的类型。  
F 运算的类型。  

模型

向量表达式 .

类型要求

无，除了 向量表达式 的要求所施加的那些。

公共基类

vector_expression<vector_unary<E, F> >

成员

成员 描述
vector_unary (const expression_type &e) 构造表达式的描述。
size_type size () const 返回表达式的大小。
const_reference operator () (size_type i) const 返回第 i 个元素的值。
const_iterator begin () const 返回指向表达式开头的 const_iterator。
const_iterator end () const 返回指向表达式结尾的 const_iterator。
const_reverse_iterator rbegin () const 返回指向反向表达式开头的 const_reverse_iterator。
const_reverse_iterator rend () const 返回指向反向表达式结尾的 const_reverse_iterator。

一元运算

原型

template<class E, class F>
    struct vector_unary_traits {
        typedef vector_unary<typename E::const_closure_type, F> expression_type;
        typedef expression_type result_type;
     };

    // (- v) [i] = - v [i]
    template<class E>
     typename vector_unary_traits<E, scalar_negate<typename E::value_type> >::result_type
    operator - (const vector_expression<E> &e);

    // (conj v) [i] = conj (v [i])
    template<class E>
     typename vector_unary_traits<E, scalar_conj<typename E::value_type> >::result_type
    conj (const vector_expression<E> &e);

    // (real v) [i] = real (v [i])
    template<class E>
     typename vector_unary_traits<E, scalar_real<typename E::value_type> >::result_type
    real (const vector_expression<E> &e);

    // (imag v) [i] = imag (v [i])
    template<class E>
     typename vector_unary_traits<E, scalar_imag<typename E::value_type> >::result_type
    imag (const vector_expression<E> &e);

    // (trans v) [i] = v [i]
    template<class E>
     typename vector_unary_traits<E, scalar_identity<typename E::value_type> >::result_type
    trans (const vector_expression<E> &e);

    // (herm v) [i] = conj (v [i])
    template<class E>
     typename vector_unary_traits<E, scalar_conj<typename E::value_type> >::result_type
    herm (const vector_expression<E> &e);

描述

operator - 计算向量表达式的加法逆元。 conj 计算向量表达式的复共轭。 real 和 imag 计算向量表达式的实部和虚部。 trans 计算向量表达式的转置。 herm 计算向量表达式的埃尔米特共轭，即转置的复共轭。

定义

定义于头文件 vector_expression.hpp 中。

类型要求

先决条件

无。

复杂度

线性复杂度，取决于向量表达式的大小。

示例

#include <boost/numeric/ublas/vector.hpp>
#include <boost/numeric/ublas/io.hpp>

int main () {
    using namespace boost::numeric::ublas;
    vector<std::complex<double> > v (3);
    for (unsigned i = 0; i < v.size (); ++ i)
        v (i) = std::complex<double> (i, i);

    std::cout << - v << std::endl;
    std::cout << conj (v) << std::endl;
    std::cout << real (v) << std::endl;
    std::cout << imag (v) << std::endl;
    std::cout << trans (v) << std::endl;
    std::cout << herm (v) << std::endl;
}

二元运算描述

描述

模板类 vector_binary<E1, E2, F> 描述二元向量运算。

定义

定义于头文件 vector_expression.hpp 中。

模板参数

参数 描述 默认值
E1 第一个向量表达式的类型。
E2 第二个向量表达式的类型。
F 运算的类型。

模型

向量表达式 .

类型要求

无，除了 向量表达式 的要求所施加的那些。

公共基类

vector_expression<vector_binary<E1, E2, F> >

成员

成员 描述
vector_binary (const expression1_type &e1, const expression2_type &e2) 构造表达式的描述。
size_type size () const 返回表达式的大小。
const_reference operator () (size_type i) const 返回第 i 个元素的值。
const_iterator begin () const 返回指向表达式开头的 const_iterator。
const_iterator end () const 返回指向表达式结尾的 const_iterator。
const_reverse_iterator rbegin () const 返回指向反向表达式开头的 const_reverse_iterator。
const_reverse_iterator rend () const 返回指向反向表达式结尾的 const_reverse_iterator。

二元运算

原型

template<class E1, class E2, class F>
    struct vector_binary_traits {
        typedef vector_binary<typename E1::const_closure_type,
                               typename E2::const_closure_type, F> expression_type;
        typedef expression_type result_type;
     };

    // (v1 + v2) [i] = v1 [i] + v2 [i]
    template<class E1, class E2>
    typename vector_binary_traits<E1, E2, scalar_plus<typename E1::value_type,
                                                       typename E2::value_type> >::result_type
    operator + (const vector_expression<E1> &e1,
                 const vector_expression<E2> &e2);

    // (v1 - v2) [i] = v1 [i] - v2 [i]
    template<class E1, class E2>
    typename vector_binary_traits<E1, E2, scalar_minus<typename E1::value_type,
                                                        typename E2::value_type> >::result_type
    operator - (const vector_expression<E1> &e1,
                 const vector_expression<E2> &e2);

描述

operator + 计算两个向量表达式的和。 operator - 计算两个向量表达式的差。

定义

定义于头文件 vector_expression.hpp 中。

类型要求

先决条件

复杂度

线性复杂度，取决于向量表达式的大小。

示例

#include <boost/numeric/ublas/vector.hpp>
#include <boost/numeric/ublas/io.hpp>

int main () {
    using namespace boost::numeric::ublas;
    vector<double> v1 (3), v2 (3);
    for (unsigned i = 0; i < std::min (v1.size (), v2.size ()); ++ i)
        v1 (i) = v2 (i) = i;

    std::cout << v1 + v2 << std::endl;
    std::cout << v1 - v2 << std::endl;
}

二元外积运算描述

描述

模板类 vector_matrix_binary<E1, E2, F> 描述二元外积向量运算。

定义

定义于头文件 matrix_expression.hpp 中。

模板参数

参数 描述 默认值
E1 第一个向量表达式的类型。
E2 第二个向量表达式的类型。
F 运算的类型。

模型

矩阵表达式 .

类型要求

无，除了 矩阵表达式 的要求所施加的那些。

公共基类

matrix_expression<vector_matrix_binary<E1, E2, F> >

成员

成员 描述
vector_matrix_binary (const expression1_type &e1, const expression2_type &e2) 构造表达式的描述。
size_type size1 () const 返回行数。
size_type size2 () const 返回列数。
const_reference operator () (size_type i, size_type j) const 返回第 i 行第 j 个元素的值。
const_iterator1 begin1 () const 返回指向表达式开头的 const_iterator1。
const_iterator1 end1 () const 返回指向表达式结尾的 const_iterator1。
const_iterator2 begin2 () const 返回指向表达式开头的 const_iterator2。
const_iterator2 end2 () const 返回指向表达式结尾的 const_iterator2。
const_reverse_iterator1 rbegin1 () const 返回指向反向表达式开头的 const_reverse_iterator1。
const_reverse_iterator1 rend1 () const 返回指向反向表达式结尾的 const_reverse_iterator1。
const_reverse_iterator2 rbegin2 () const 返回指向反向表达式开头的 const_reverse_iterator2。
const_reverse_iterator2 rend2 () const 返回指向反向表达式结尾的 const_reverse_iterator2。

二元外积运算

原型

template<class E1, class E2, class F>
    struct vector_matrix_binary_traits {
        typedef vector_matrix_binary<typename E1::const_closure_type,
                                      typename E2::const_closure_type, F> expression_type;
        typedef expression_type result_type;
     };

    // (outer_prod (v1, v2)) [i] [j] = v1 [i] * v2 [j]
    template<class E1, class E2>
    typename vector_matrix_binary_traits<E1, E2, scalar_multiplies<typename E1::value_type, typename E2::value_type> >::result_type
    outer_prod (const vector_expression<E1> &e1,
                 const vector_expression<E2> &e2);

描述

outer_prod 计算两个向量表达式的外积。

定义

定义于头文件 matrix_expression.hpp 中。

类型要求

先决条件

无。

复杂度

二次复杂度，取决于向量表达式的大小。

示例

#include <boost/numeric/ublas/matrix.hpp>
#include <boost/numeric/ublas/io.hpp>

int main () {
    using namespace boost::numeric::ublas;
    vector<double> v1 (3), v2 (3);
    for (unsigned i = 0; i < std::min (v1.size (), v2.size ()); ++ i)
        v1 (i) = v2 (i) = i;

    std::cout << outer_prod (v1, v2) << std::endl;
}

标量向量运算描述

描述

模板类 vector_binary_scalar1<E1, E2, F> 和 vector_binary_scalar2<E1, E2, F> 描述标量和向量之间的二元运算。

定义

定义于头文件 vector_expression.hpp 中。

模板参数

参数 描述 默认值
E1/E2 标量表达式的类型。
E2/E1 向量表达式的类型。
F 运算的类型。

模型

向量表达式 .

类型要求

无，除了 向量表达式 的要求所施加的那些。

公共基类

vector_expression<vector_binary_scalar1<E1, E2, F> > 和 vector_expression<vector_binary_scalar2<E1, E2, F> > 分别。

成员

成员 描述
vector_binary_scalar1 (const expression1_type &e1, const expression2_type &e2) 构造表达式的描述。
vector_binary_scalar2 (const expression1_type &e1, const expression2_type &e2) 构造表达式的描述。
size_type size () const 返回表达式的大小。
const_reference operator () (size_type i) const 返回第 i 个元素的值。
const_iterator begin () const 返回指向表达式开头的 const_iterator。
const_iterator end () const 返回指向表达式结尾的 const_iterator。
const_reverse_iterator rbegin () const 返回指向反向表达式开头的 const_reverse_iterator。
const_reverse_iterator rend () const 返回指向反向表达式结尾的 const_reverse_iterator。

标量向量运算

原型

template<class T1, class E2, class F>
    struct vector_binary_scalar1_traits {
        typedef vector_binary_scalar1<scalar_const_reference<T1>,
                                      typename E2::const_closure_type, F> expression_type;
        typedef expression_type result_type;
    };

    // (t * v) [i] = t * v [i]
    template<class T1, class E2>
    typename vector_binary_scalar1_traits<T1, E2, scalar_multiplies<T1, typename E2::value_type> >::result_type
    operator * (const T1 &e1,
                const vector_expression<E2> &e2);

    template<class E1, class T2, class F>
    struct vector_binary_scalar2_traits {
        typedef vector_binary_scalar2<typename E1::const_closure_type,
                                      scalar_const_reference<T2>, F> expression_type;
        typedef expression_type result_type;
    };

    // (v * t) [i] = v [i] * t
    template<class E1, class T2>
    typename vector_binary_scalar2_traits<E1, T2, scalar_multiplies<typename E1::value_type, T2> >::result_type
    operator * (const vector_expression<E1> &e1,
                const T2 &e2);

    // (v / t) [i] = v [i] / t
    template<class E1, class T2>
    typename vector_binary_scalar2_traits<E1, T2, scalar_divides<typename E1::value_type, T2> >::result_type
    operator / (const vector_expression<E1> &e1,
                const T2 &e2);

描述

operator * 计算标量和向量表达式的乘积。 operator / 将向量与标量的倒数相乘。

定义

定义于头文件 vector_expression.hpp 中。

类型要求

先决条件

无。

复杂度

线性复杂度，取决于向量表达式的大小。

示例

#include <boost/numeric/ublas/vector.hpp>
#include <boost/numeric/ublas/io.hpp>

int main () {
    using namespace boost::numeric::ublas;
    vector<double> v (3);
    for (unsigned i = 0; i < v.size (); ++ i)
        v (i) = i;

    std::cout << 2.0 * v << std::endl;
    std::cout << v * 2.0 << std::endl;
}

向量归约

一元归约

原型

template<class E, class F>
    struct vector_scalar_unary_traits {
         typedef typename F::result_type result_type;
    };

    // sum v = sum (v [i])
    template<class E>
    typename vector_scalar_unary_traits<E, vector_sum<typename E::value_type> >::result_type
    sum (const vector_expression<E> &e);

    // norm_1 v = sum (abs (v [i]))
    template<class E>
    typename vector_scalar_unary_traits<E, vector_norm_1<typename E::value_type> >::result_type
    norm_1 (const vector_expression<E> &e);

    // norm_2 v = sqrt (sum (v [i] * v [i]))
    template<class E>
    typename vector_scalar_unary_traits<E, vector_norm_2<typename E::value_type> >::result_type
    norm_2 (const vector_expression<E> &e);

    // norm_2_square v = sum (v [i] * v [i])
    template<class E>
    typename vector_scalar_unary_traits<E, vector_norm_2_square<typename E::value_type> >::result_type
    norm_2_square (const vector_expression<E> &e);

    // norm_inf v = max (abs (v [i]))
    template<class E>
    typename vector_scalar_unary_traits<E, vector_norm_inf<typename E::value_type> >::result_type
    norm_inf (const vector_expression<E> &e);

    // index_norm_inf v = min (i: abs (v [i]) == max (abs (v [i])))
    template<class E>
    typename vector_scalar_unary_traits<E, vector_index_norm_inf<typename E::value_type> >::result_type
    index_norm_inf (const vector_expression<E> &e);

描述

sum 计算向量表达式元素的总和。 norm_1、norm_2 和 norm_inf 计算相应的 ||.||1、||.||2 和 ||.||inf 向量范数。 index_norm_1 计算向量表达式的第一个具有最大绝对值的元素的索引。

定义

定义于头文件 vector_expression.hpp 中。

类型要求

先决条件

无。

复杂度

线性复杂度，取决于向量表达式的大小。

示例

#include <boost/numeric/ublas/vector.hpp>

int main () {
    using namespace boost::numeric::ublas;
    vector<double> v (3);
    for (unsigned i = 0; i < v.size (); ++ i)
        v (i) = i;

    std::cout << sum (v) << std::endl;
    std::cout << norm_1 (v) << std::endl;
    std::cout << norm_2 (v) << std::endl;
    std::cout << norm_inf (v) << std::endl;
    std::cout << index_norm_inf (v) << std::endl;
}

二元归约

原型

template<class E1, class E2, class F>
    struct vector_scalar_binary_traits {
        typedef typename F::result_type result_type;
    };

    // inner_prod (v1, v2) = sum (v1 [i] * v2 [i])
    template<class E1, class E2>
    typename vector_scalar_binary_traits<E1, E2, vector_inner_prod<typename E1::value_type,
                                                                   typename E2::value_type,
                                                                   typename promote_traits<typename E1::value_type,
                                                                                           typename E2::value_type>::promote_type> >::result_type
    inner_prod (const vector_expression<E1> &e1,
                const vector_expression<E2> &e2);

    template<class E1, class E2>
    typename vector_scalar_binary_traits<E1, E2, vector_inner_prod<typename E1::value_type,
                                                                   typename E2::value_type,
                                                                   typename type_traits<typename promote_traits<typename E1::value_type,
                                                                                                                typename E2::value_type>::promote_type>::precision_type> >::result_type
    prec_inner_prod (const vector_expression<E1> &e1,
                     const vector_expression<E2> &e2);

描述

inner_prod 计算向量表达式的内积。 prec_inner_prod 计算向量表达式的双精度内积。

定义

定义于头文件 vector_expression.hpp 中。

类型要求

先决条件

复杂度

线性复杂度，取决于向量表达式的大小。

示例

#include <boost/numeric/ublas/vector.hpp>

int main () {
    using namespace boost::numeric::ublas;
    vector<double> v1 (3), v2 (3);
    for (unsigned i = 0; i < std::min (v1.size (), v2.size ()); ++ i)
        v1 (i) = v2 (i) = i;

    std::cout << inner_prod (v1, v2) << std::endl;
}

版权 (©) 2000-2002 Joerg Walter, Mathias Koch
使用、修改和分发受 Boost 软件许可协议 1.0 版的约束。（请参阅随附文件 LICENSE_1_0.txt 或在 https://boost.ac.cn/LICENSE_1_0.txt 复制）。