:
size_tNumRanges>
classextent_gen{
range_listranges_;//(2-1)
......
extent_gen(constextent_gen&rhs,constrange&a_range)//(2-2)
{
std:
:
copy(rhs.ranges_.begin(),rhs.ranges_.end(),ranges_.begin());
*ranges_.rbegin()=a_range;
}
extent_gen
operator[](indexidx)//(2-3)
{returnextent_gen(*this,range(0,idx));}
};
所以,boost:
:
extents[3][4][2]展开为操作符调用的方式就相当于:
extents.operator[](3).operator[](4).operator[]
(2);
extents是extent_gen<0>类型的,extents.operator[](3)应调用函数(2-3),此时NumRange为0,而返回类型是extent_gen<1>;再以该返回对象调用operator[](4),此时NumRange为1,而返回类型则是extent_gen<2>了。
再看函数(2-3)的内容,其实就是将参数idx以range包装一下再转发给构造函数(2-2),注意此时调用的是extent_gen类型的构造函数。
至于range(0,idx)则表示一个[0,idx)的区间。
进入构造函数(2-2),我们注意到extent_gen<...>中具有public的成员ranges_,声明位于(2-1)处,而ranges_就是一个容器,保存了一系列的range。
跟踪这些代码,基本了解了extents的工作方式:
每调用一次operator[],都会返回一个extent_gen类型的对象,所以,对于boost:
:
extents[3][4][2],依次返回的是:
extent_gen<1>=>extent_gen<2>=>extent_gen<3>
最后一个也是最终的返回类型——extent_gen<3>。
其成员ranges_中,共有[0,3)、[0,4)、[0,2)三组区间。
这三组区间指定了我们定义的multi_array对象的三个维度的下标区间,值得注意的是这些区间都是前闭后开的,即不包含上界值,这一点在后面的代码中能够看到。
当boost:
:
extents准备完毕后,就被传入multi_array的构造函数,用于指定各维的下标区间:
//multi_array.hpp
explicitmulti_array(constextent_gen&ranges):
super_type((T*)initial_base_,ranges){
allocate_space();//(2-5)
}
这里,multi_array接受了ranges参数中的信息,取出其中各维的下标区间,然后保存,最后调用allocate_space()来分配底层内存。
使用extent_gen的好处
使用boost:
:
extents作参数的构造过程和内建多维数组的方式一致,简练直观,语义清晰。
首先,boost:
:
extents使用“[]”,能让人很容易想到内建多维数组的声明,也很清晰地表达了每个方括号中数值的含义——表明各维度的容量区间;最关键的还是,使用boost:
:
extents,可以防止用户写出错误的代码,例如:
multi_arrayA(boost:
:
extents[3][4][2][5]);//错!
多了一维!
上面的语句是无法通过编译,因为mult_array是个三维数组,而boost:
:
extents后面却跟了四个“[]”,这显然是个错误;在语法层面,由于multi_array的构造函数只能接受extent_gen<3>类型的参数,而根据我们前面对extents的分析,boost:
:
extents[3][4][2][5]返回的却是extent_gen<4>类型的对象,于是就会产生编译错误。
这种编译期的强制措施阻止了用户一不小心犯下的错误(如果你正在打瞌睡呢?
),也很清晰明了地表达(强制)了语义的需求。
另一种替代方案及其缺点
另外,还有一种声明各维大小的替代方式,就是使用所谓的CollectionConcept,例如:
//声明一个shape(“形状”),即各个维度的size
boost:
:
arrayshape={{3,4,2}};
array_typeB(shape);//3*4*2的三维数组
这种方式将调用multi_array的第二种构造函数:
//multi_array.hpp
template
explicitmulti_array(ExtentListconst&extents):
super_type((T*)initial_base_,extents){
boost:
:
function_requires/(2-4)
detail:
:
multi_array:
:
CollectionConcept>();
allocate_space();//(2-6)
}
这个构造函数的形参extents只要是符合collectionconcept就可以了——shape的类型为boost:
:
array,当然符合这个concept。
这个构造函数的行为与接受extents_gen的构造函数是一样的——仍然是先取出各维的range保存下来,然后分配底层内存。
至于(2-4)处的代码,功能就是在编译期检查模板参数ExtentList是否符合Collectionconcept,实现细节在此不再赘述。
把这种方式与使用extent_gen的方式作一个简单的比较,很容易就看出优劣:
采用这种方式,就不能保证编译期能够进行正确性的检查了,例如:
boost:
:
arrayshape={{3,4,2,5}};//一个四维数组的shape
multi_arrayA(shape);//竟然可以通过编译!
!
这里,用一个四维的shape来指定一个三维multi_array显然是错误的,但是居然通过了编译,这是由于这个构造函数将它的参数extents作为一个普通的collection来对待,构造函数根据自己的需求用iterator从extents中取出它所需要的数值——A是三维数组,于是构造函数从shape中取出前三个数值作为A三个维度的下标区间,而不管shape究竟是包含了几个数值。
这样的语句在语义上是不清晰甚至错误的。
但是既然这样的构造函数存在,设计者自然有他的道理,文档中就明确的表明,这个构造函数最大的用处就是编写维度无关(dimension-independent)的代码,除此之外multi_array库默认为前一种构造函数。
multi_array的架构
无论采用哪一种构造函数,代码流程却是相似的——将一系列下标区间传入基类的构造函数中去,基类构造完成之后就调用相同的allocate_space()函数(见(2-5)和(2-6)处),allocate_space,顾名思义,应该是为多维数组的元素分配空间的。
但是对于这样在派生类而非基类的构造中分配存储空间的设计,可能的合理解释就是:
基类是个适配器(adapter),它决定了一切对原始数据的访问规则,描述了multi_array对外界的接口。
顺着基类的构造函数,我们继续向multi_array的深处探索。
//multi_array_ref.hpp
template:
size_tNumDims>
classmulti_array_ref:
//multi_array的基类!
!
publicconst_multi_array_ref
{
typedefconst_multi_array_refsuper_type;
......
explicitmulti_array_ref(T*base,//指向数组存储空间的指针
constextent_gen&ranges):
//下标区间
super_type(base,ranges)//把初始化的任务转发给基类(3-1)
{}
......
};
//multi_array_ref.hpp
classconst_multi_array_ref:
//multi_array_ref的基类!
管理底层存储!
publicmulti_array_impl_base
{
......
explicitconst_multi_array_ref(TPtrbase,
constextent_gen&ranges):
base_(base),storage_(c_storage_order())//(3-2)
{init_from_extent_gen(ranges);}
......
storage_order_typestorage_;//支持多种存储策略!
(3-3)
};
multi_array基类对象的构造之路途径(3-1)处multi_array_ref的构造函数,延伸至(3-2)处const_multi_array_ref的构造函数——这里看似一个终结,因为再没有参数传递给const_multi_array_ref的基类multi_array_impl_base了。
但是心中还是疑惑:
为什么会有如此多层的继承结构?
这样的类层次结构设计究竟有什么玄机呢?
多层继承的奥秘——复用性
转到基类const_multi_array_ref的声明,似乎可以看出一些端倪:
template<...>
classconst_multi_array_ref{
......
//和所有的STL容器一致的迭代器界面!
!
const_iteratorbegin()const;
const_iteratorend()const;
......
//和std:
:
vector一致的元素访问界面!
!
const_referenceoperator[](indexi)const;
......
};
看到上面这些声明,是不是有些面熟?
STL!
对,这些成员函数的声明是与STL中containerconcept完全一致的。
所谓与STL的兼容性正是在这里体现出来了。
而const_multi_array_ref更是“类如其名”,const_multi_array_ref中所有访问元素、查询数组信息等成员函数都返回const的reference或iterator。
而反观multi_array_ref的声明,其中只比const_multi_array_ref多了访问元素、查询数组信息的对应的non-const版本成员函数。
那么const_multi_array_ref的基类multi_array_impl_base的职责是什么呢?
接着展开类multi_array_impl_base的声明,
multi_array_impl_base是属于实现细节的,它的作用只是根据数组信息(const_multi_array_ref中的成员变量)计算偏移量、步长等,也就是把多维的下标最终转化为一维偏移量。
而multi_array_impl_base的基类——或者是value_accessor_n或者是value_accessor_one——的功能就是提供一个对原始数据的访问。
这在下文详述。
至此,对multi_array的基类子对象大致有了了解——它们的继承关系如下:
multi_array->multi_array_ref->const_multi_array_ref->multi_array_impl_base->value_accessor_n/value_accessor_one
其中每一层都担任各自的角色:
♦multi_array:
为数组元素分配空间,将各种操作转发至基类。
♦multi_array_ref:
提供与STL容器一致的数据访问界面。
也可以独立出来作为一个adapter使用。
♦const_multi_array_ref:
提供const的STL数据访问界面。
也可以作为一个constadapter使用。
♦multi_array_impl_base及其基类:
最底层实现,提供一组对原始数据的基本操作。
这种架构看似复杂,却提供了极高的复用性,其中的(const_)multi_array_ref都可以独立出来作为一个adapter使用——例如:
inta[24];//一维的10个元素数组
//把一维数组a看成一个3*4*2的三维数组:
multi_array_refarr_ref(a,boost:
:
extents[3][4][2]);
arr_ref[i][j][k]=value;//和multi_array一样的使用界面
倘若你不想让multi_array来自动分配内存的话,你可以自行分配数组(可以位于栈上或堆上)然后用multi_array_ref把它包装成一个多维的数组。
multi_array的存储策略
接下来,就来看看multi_array的存储策略,例如:
C风格的多维数组存储方式是按行存储,而fortran恰恰相反,是按列存储,甚至,用户可能有自己的存储策略要求。
那么,如何支持多种风格的存储策略呢?
秘密就在于代码(3-3)处,const_multi_array_ref的成员storage_——其类型为storage_order_type,下面的声明指出了storage_order_type的“本来面目”——general_storage_order:
//multi_array_ref.hpp
......
typedefgeneral_storage_orderstorage_order_type;
......
//storage_order.hpp
template:
size_tNumDims>
classgeneral_storage_order{
general_storage_order(constc_storage_order&){//(4-1)
for(size_typei=0;i!
=NumDims;++i)
{ordering_[i]=NumDims-1-i;}
ascending_.assign(true);
}
......
boost:
:
arrayordering_;
boost:
:
arrayascending_;
};
在(4-1)处的构造函数中,ordering_和ascending_是两个数组,当函数(4-1)执行完毕后,ordering_中的元素应当是{NumDims-1,NumDims-2,...1,0},如果将这些元素作为各维度存储顺序的标识——具有较小ordering_值的维度先存储——那么这和C语言中的存储方式就完全一致了,ascending_勿庸置疑就是用来表明各维度是否升序存储。
其实general_storage_order还有一个模板构造函数,它是为了支持更为一般化的存储策略(例如fortran的按列存储或用户自定义的存储策略)。
这里不作详述。
除了存储策略,const_multi_array_ref的构造还通过调用init_from_extent_gen函数,将extents中的内容取出来进行处理,并以此设定其它若干表述多维数组的变量((3-3)处其它一些变量),具体细节不再赘述。
现在关于一个多维数组的所有信息都已经准备齐备,可谓“万事具备,只欠‘空间’”。
multi_array下面要做的就是调用前面提到的allocate_space来为数组中的元素分配空间了。
//multi_array.hpp
voidallocate_space(){
......
base_=allocator_.allocate(