 |
Reference documentation for deal.II version 9.3.3
|
|
Reference documentation for deal.II version 9.3.3
|
#include <deal.II/base/table.h>
Public Types | |
| using | size_type = typename TableBase< 2, T >::size_type |
| using | value_type = typename AlignedVector< T >::value_type |
| using | reference = typename AlignedVector< T >::reference |
| using | const_reference = typename AlignedVector< T >::const_reference |
| using | const_iterator = MatrixTableIterators::Iterator< Table< 2, T >, true, MatrixTableIterators::Storage::row_major > |
| using | iterator = MatrixTableIterators::Iterator< Table< 2, T >, false, MatrixTableIterators::Storage::row_major > |
Public Member Functions | |
| Table ()=default | |
| Table (const size_type size1, const size_type size2) | |
| template<typename InputIterator > | |
| Table (const size_type size1, const size_type size2, InputIterator entries, const bool C_style_indexing=true) | |
| void | reinit (const size_type size1, const size_type size2, const bool omit_default_initialization=false) |
| ::internal::TableBaseAccessors::Accessor< 2, T, true, 1 > | operator[] (const size_type i) const |
| ::internal::TableBaseAccessors::Accessor< 2, T, false, 1 > | operator[] (const size_type i) |
| AlignedVector< T >::const_reference | operator() (const size_type i, const size_type j) const |
| AlignedVector< T >::reference | operator() (const size_type i, const size_type j) |
| size_type | n_rows () const |
| size_type | n_cols () const |
| iterator | begin () |
| const_iterator | begin () const |
| iterator | end () |
| const_iterator | end () const |
| bool | operator== (const TableBase< N, T > &T2) const |
| void | reset_values () |
| void | reinit (const TableIndices< N > &new_size, const bool omit_default_initialization=false) |
| size_type | size (const unsigned int i) const |
| const TableIndices< N > & | size () const |
| size_type | n_elements () const |
| bool | empty () const |
| void | fill (InputIterator entries, const bool C_style_indexing=true) |
| void | fill (const T &value) |
| AlignedVector< T >::reference | operator() (const TableIndices< N > &indices) |
| AlignedVector< T >::const_reference | operator() (const TableIndices< N > &indices) const |
| void | replicate_across_communicator (const MPI_Comm &communicator, const unsigned int root_process) |
| void | swap (TableBase< N, T > &v) |
| std::size_t | memory_consumption () const |
| void | serialize (Archive &ar, const unsigned int version) |
Protected Member Functions | |
| AlignedVector< T >::reference | el (const size_type i, const size_type j) |
| AlignedVector< T >::const_reference | el (const size_type i, const size_type j) const |
| size_type | position (const TableIndices< N > &indices) const |
| AlignedVector< T >::reference | el (const TableIndices< N > &indices) |
| AlignedVector< T >::const_reference | el (const TableIndices< N > &indices) const |
Protected Attributes | |
| AlignedVector< T > | values |
| TableIndices< N > | table_size |
Subscriptor functionality | |
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class. | |
| void | subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const |
| void | unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const |
| unsigned int | n_subscriptions () const |
| template<typename StreamType > | |
| void | list_subscribers (StreamType &stream) const |
| void | list_subscribers () const |
| using | map_value_type = decltype(counter_map)::value_type |
| using | map_iterator = decltype(counter_map)::iterator |
| std::atomic< unsigned int > | counter |
| std::map< std::string, unsigned int > | counter_map |
| std::vector< std::atomic< bool > * > | validity_pointers |
| const std::type_info * | object_info |
| static std::mutex | mutex |
| static ::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
| static ::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
| void | check_no_subscribers () const noexcept |
A class representing a two-dimensional table, i.e. a matrix of objects (not necessarily only numbers). The majority of the interface of this class is implemented in the TableBase base class. See there for an outline of the rationale for and interface of this class.
This class also serves as the base class for the FullMatrix class and consequently has a number of functions that are specific to matrices and their needs.
| using Table< 2, T >::value_type = typename AlignedVector<T>::value_type |
| using Table< 2, T >::reference = typename AlignedVector<T>::reference |
| using Table< 2, T >::const_reference = typename AlignedVector<T>::const_reference |
| using Table< 2, T >::const_iterator = MatrixTableIterators:: Iterator<Table<2, T>, true, MatrixTableIterators::Storage::row_major> |
| using Table< 2, T >::iterator = MatrixTableIterators:: Iterator<Table<2, T>, false, MatrixTableIterators::Storage::row_major> |
Default constructor. Set all dimensions to zero.
Constructor. Pass down the given dimensions to the base class.
| Table< 2, T >::Table | ( | const size_type | size1, |
| const size_type | size2, | ||
| InputIterator | entries, | ||
| const bool | C_style_indexing = true |
||
| ) |
Constructor. Create a table with a given size and initialize it from a set of iterators.
This function is entirely equivalent to creating a table t of the given size and then calling
on it, using the TableBase::fill() function where the arguments are explained in more detail. The point, however, is that that is only possible if the table can be changed after running the constructor, whereas calling the current constructor allows sizing and initializing an object right away so that it can be marked const.
Using this constructor, you can do things like this:
You can also initialize a table right from a file, using input iterators:
| size1 | The size of this table in the first dimension. |
| size2 | The size of this table in the second dimension. |
| entries | An iterator to a set of elements from which to initialize this table. It is assumed that iterator can be incremented and dereferenced a sufficient number of times to fill this table. |
| C_style_indexing | If true, run over elements of the table with the last index changing fastest as we dereference subsequent elements of the input range. If false, change the first index fastest. |
| void Table< 2, T >::reinit | ( | const size_type | size1, |
| const size_type | size2, | ||
| const bool | omit_default_initialization = false |
||
| ) |
Reinitialize the object. This function is mostly here for compatibility with the earlier vector2d class. Passes down to the base class by converting the arguments to the data type requested by the base class.
| ::internal::TableBaseAccessors::Accessor< 2, T, true, 1 > Table< 2, T >::operator[] | ( | const size_type | i | ) | const |
Access operator. Generate an object that accesses the requested row of this two-dimensional table. Range checks are performed.
This version of the function only allows read access.
| ::internal::TableBaseAccessors::Accessor< 2, T, false, 1 > Table< 2, T >::operator[] | ( | const size_type | i | ) |
Access operator. Generate an object that accesses the requested row of this two-dimensional table. Range checks are performed.
This version of the function allows read-write access.
| AlignedVector< T >::const_reference Table< 2, T >::operator() | ( | const size_type | i, |
| const size_type | j | ||
| ) | const |
Direct access to one element of the table by specifying all indices at the same time. Range checks are performed.
This version of the function only allows read access.
| AlignedVector< T >::reference Table< 2, T >::operator() | ( | const size_type | i, |
| const size_type | j | ||
| ) |
Direct access to one element of the table by specifying all indices at the same time. Range checks are performed.
This version of the function allows read-write access.
Number of rows. This function really makes only sense since we have a two-dimensional object here.
Number of columns. This function really makes only sense since we have a two-dimensional object here.
Return an iterator pointing to the first entry.
| const_iterator Table< 2, T >::begin | ( | ) | const |
Return a constant iterator pointing to the first entry.
Return an iterator pointing to one past the last entry.
| const_iterator Table< 2, T >::end | ( | ) | const |
Return a constant iterator pointing to one past the last entry.
|
protected |
Return a read-write reference to the element (i,j).
This function does no bounds checking and is only to be used internally and in functions already checked.
These functions are mainly here for compatibility with a former implementation of these table classes for 2d arrays, then called vector2d.
|
protected |
Return the value of the element (i,j) as a read-only reference.
This function does no bounds checking and is only to be used internally and in functions already checked.
We return the requested value as a constant reference rather than by value since this object may hold data types that may be large, and we don't know here whether copying is expensive or not.
These functions are mainly here for compatibility with a former implementation of these table classes for 2d arrays, then called vector2d.
Test for equality of two tables.
|
inherited |
Set all entries to their default value (i.e. copy them over with default constructed objects). Do not change the size of the table, though.
|
inherited |
Set the dimensions of this object to the sizes given in the first argument, and allocate the required memory for table entries to accommodate these sizes. If omit_default_initialization is set to false, all elements of the table are set to a default constructed object for the element type. Otherwise the memory is left in an uninitialized or otherwise undefined state.
Size of the table in direction i.
|
inherited |
Return the sizes of this object in each direction.
Return the number of elements stored in this object, which is the product of the extensions in each dimension.
Return whether the object is empty, i.e. one of the directions is zero. This is equivalent to n_elements()==0.
|
inherited |
Fill this table (which is assumed to already have the correct size) from a source given by dereferencing the given forward iterator (which could, for example, be a pointer to the first element of an array, or an inserting std::istream_iterator). The second argument denotes whether the elements pointed to are arranged in a way that corresponds to the last index running fastest or slowest. The default is to use C-style indexing where the last index runs fastest (as opposed to Fortran-style where the first index runs fastest when traversing multidimensional arrays. For example, if you try to fill an object of type Table<2,T>, then calling this function with the default value for the second argument will result in the equivalent of doing
On the other hand, if the second argument to this function is false, then this would result in code of the following form:
Note the switched order in which we fill the table elements by traversing the given set of iterators.
| entries | An iterator to a set of elements from which to initialize this table. It is assumed that iterator can be incremented and dereferenced a sufficient number of times to fill this table. |
| C_style_indexing | If true, run over elements of the table with the last index changing fastest as we dereference subsequent elements of the input range. If false, change the first index fastest. |
|
inherited |
Fill all table entries with the same value.
|
inherited |
Return a read-write reference to the indicated element.
|
inherited |
Return the value of the indicated element as a read-only reference.
We return the requested value as a constant reference rather than by value since this object may hold data types that may be large, and we don't know here whether copying is expensive or not.
|
inherited |
This function replicates the state found on the process indicated by root_process across all processes of the MPI communicator. The current state found on any of the processes other than root_process is lost in this process. One can imagine this operation to act like a call to Utilities::MPI::broadcast() from the root process to all other processes, though in practice the function may try to move the data into shared memory regions on each of the machines that host MPI processes and let all MPI processes on this machine then access this shared memory region instead of keeping their own copy. See the general documentation of this class for a code example.
The intent of this function is to quickly exchange large arrays from one process to others, rather than having to compute or create it on all processes. This is specifically the case for data loaded from disk – say, large data tables – that are more easily dealt with by reading once and then distributing across all processes in an MPI universe, than letting each process read the data from disk itself. Specifically, the use of shared memory regions allows for replicating the data only once per multicore machine in the MPI universe, rather than replicating data once for each MPI process. This results in large memory savings if the data is large on today's machines that can easily house several dozen MPI processes per shared memory space.
This function does not imply a model of keeping data on different processes in sync, as parallel::distributed::Vector and other vector classes do where there exists a notion of certain elements of the vector owned by each process and possibly ghost elements that are mirrored from its owning process to other processes. Rather, the elements of the current object are simply copied to the other processes, and it is useful to think of this operation as creating a set of const AlignedVector objects on all processes that should not be changed any more after the replication operation, as this is the only way to ensure that the vectors remain the same on all processes. This is particularly true because of the use of shared memory regions where any modification of a vector element on one MPI process may also result in a modification of elements visible on other processes, assuming they are located within one shared memory node.
communicator object, which is generally an expensive operation. Likewise, the generation of shared memory spaces is not a cheap operation. As a consequence, this function primarily makes sense when the goal is to share large read-only data tables among processes; examples are data tables that are loaded at start-up time and then used over the course of the run time of the program. In such cases, the start-up cost of running this function can be amortized over time, and the potential memory savings from not having to store the table on each process may be substantial on machines with large core counts on which many MPI processes run on the same machine.T is "self-contained", i.e., all of its information is stored in its member variables, and if none of the member variables are pointers to other parts of the memory. This is because if a type T does have pointers to other parts of memory, then moving T into a shared memory space does not result in the other processes having access to data that the object points to with its member variable pointers: These continue to live only on one process, and are typically in memory areas not accessible to the other processes. As a consequence, the usual use case for this function is to share arrays of simple objects such as doubles or ints.root_process throw away their data, which is not a collective operation. Generally, these restrictions on what can and can not be done hint at the correctness of the comments above: You should treat an AlignedVector on which the current function has been called as const, on which no further operations can be performed until the destructor is called. Swap the contents of this table and the other table v. One could do this operation with a temporary variable and copying over the data elements, but this function is significantly more efficient since it only swaps the pointers to the data of the two vectors and therefore does not need to allocate temporary storage and move data around.
This function is analogous to the swap function of all C++ standard containers. Also, there is a global function swap(u,v) that simply calls u.swap(v), again in analogy to standard functions.
|
inherited |
Determine an estimate for the memory consumption (in bytes) of this object.
Write or read the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.
|
protectedinherited |
Return the position of the indicated element within the array of elements stored one after the other. This function does no index checking.
|
protectedinherited |
Return a read-write reference to the indicated element.
This function does no bounds checking and is only to be used internally and in functions already checked.
|
protectedinherited |
Return the value of the indicated element as a read-only reference.
This function does no bounds checking and is only to be used internally and in functions already checked.
We return the requested value as a constant reference rather than by value since this object may hold data types that may be large, and we don't know here whether copying is expensive or not.
|
friend |
|
friend |
|
friend |
|
protectedinherited |
|
protectedinherited |
1.9.4