3
0
mirror of https://github.com/triqs/dft_tools synced 2024-12-28 07:13:41 +01:00
dft_tools/doc/reference/c++/arrays/shape.rst
Olivier Parcollet f2c7d449cc First commit : triqs libs version 1.0 alpha1
for earlier commits, see TRIQS0.x repository.
2013-07-17 19:24:07 +02:00

51 lines
928 B
ReStructuredText

.. _Shape:
Shape, resize
==================================
Lengths
----------
Shape
--------------------
* array, matrix and vector have a method shape() that returns a `shape_type` object
i.e. a mini_vector<size_t,rank>. DOCUMENT THIS ?
* Example::
array<double,2> A(2,3);
A.shape()[0] == 2;
A.shape()[1] == 3;
Resize
--------
* The value classes array, matrix and vector can be resized.
* **Synopsis**:
.. cpp:function:: void resize(size_t, ..., size_t)
* **Examples** ::
array<double,2> A(2,3);
A.resize ( make_shape (5,5) )
matrix<double,2> M;
M.resize( 3,3);
vector<double> V;
V.resize(10);
* Views can not be resized.
resize_or_check_if_view
----------------------------
.. cpp:function:: void resize_or_check_if_view(ArrayType const & A, shape_t)
* If A is a value : resize A
* If A is a view : check that the shape if the shape_t and throw an exception if not.