GEOSX
Classes | Namespaces | Macros
ArrayOfArraysView.hpp File Reference

Contains the implementation of LvArray::ArrayOfArraysView. More...

#include "bufferManipulation.hpp"
#include "arrayManipulation.hpp"
#include "ArraySlice.hpp"
#include "typeManipulation.hpp"
#include "math.hpp"
#include <RAJA/RAJA.hpp>
#include <cstring>

Go to the source code of this file.

Classes

class  LvArray::ArrayOfArraysView< T, INDEX_TYPE, CONST_SIZES, BUFFER_TYPE >
 This class provides a view into an array of arrays like object. More...
 

Namespaces

 LvArray
 The top level namespace.
 

Macros

#define ARRAYOFARRAYS_CHECK_BOUNDS(i)
 Check that i is a valid array index. More...
 
#define ARRAYOFARRAYS_CHECK_BOUNDS2(i, j)
 Check that i is a valid array index and that j is a valid index into that array. More...
 
#define ARRAYOFARRAYS_CHECK_INSERT_BOUNDS(i)
 Check that i is a valid index to insert an array at. More...
 
#define ARRAYOFARRAYS_CHECK_INSERT_BOUNDS2(i, j)
 Check that i is a valid array index and that j is a valid insertion index into that array. More...
 
#define ARRAYOFARRAYS_CAPACITY_CHECK(i, increase)
 Check that the capacity of array i isn't exceeded when the size is increased by increase. More...
 
#define ARRAYOFARRAYS_ATOMIC_CAPACITY_CHECK(i, previousSize, increase)
 Check that the capacity of array i isn't exceeded when the size is increased by increase. More...
 

Detailed Description

Contains the implementation of LvArray::ArrayOfArraysView.

Definition in file ArrayOfArraysView.hpp.

Macro Definition Documentation

◆ ARRAYOFARRAYS_ATOMIC_CAPACITY_CHECK

#define ARRAYOFARRAYS_ATOMIC_CAPACITY_CHECK (   i,
  previousSize,
  increase 
)

Check that the capacity of array i isn't exceeded when the size is increased by increase.

Parameters
iThe array index to check.
previousSizeThe previous size of the array.
increaseThe increases in the capacity.
Note
This is only active when LVARRAY_BOUNDS_CHECK is defined.

Definition at line 144 of file ArrayOfArraysView.hpp.

◆ ARRAYOFARRAYS_CAPACITY_CHECK

#define ARRAYOFARRAYS_CAPACITY_CHECK (   i,
  increase 
)

Check that the capacity of array i isn't exceeded when the size is increased by increase.

Parameters
iThe array index to check.
increaseThe increases in the capacity.
Note
This is only active when LVARRAY_BOUNDS_CHECK is defined.

Definition at line 135 of file ArrayOfArraysView.hpp.

◆ ARRAYOFARRAYS_CHECK_BOUNDS

#define ARRAYOFARRAYS_CHECK_BOUNDS (   i)

Check that i is a valid array index.

Parameters
iThe array index to check.
Note
This is only active when LVARRAY_BOUNDS_CHECK is defined.

Definition at line 104 of file ArrayOfArraysView.hpp.

◆ ARRAYOFARRAYS_CHECK_BOUNDS2

#define ARRAYOFARRAYS_CHECK_BOUNDS2 (   i,
 
)

Check that i is a valid array index and that j is a valid index into that array.

Parameters
iThe array index to check.
jThe index into the array to check.
Note
This is only active when LVARRAY_BOUNDS_CHECK is defined.

Definition at line 112 of file ArrayOfArraysView.hpp.

◆ ARRAYOFARRAYS_CHECK_INSERT_BOUNDS

#define ARRAYOFARRAYS_CHECK_INSERT_BOUNDS (   i)

Check that i is a valid index to insert an array at.

Parameters
iThe array index to check.
Note
This is only active when LVARRAY_BOUNDS_CHECK is defined.

Definition at line 119 of file ArrayOfArraysView.hpp.

◆ ARRAYOFARRAYS_CHECK_INSERT_BOUNDS2

#define ARRAYOFARRAYS_CHECK_INSERT_BOUNDS2 (   i,
 
)

Check that i is a valid array index and that j is a valid insertion index into that array.

Parameters
iThe array index to check.
jThe index into the array to check.
Note
This is only active when LVARRAY_BOUNDS_CHECK is defined.

Definition at line 127 of file ArrayOfArraysView.hpp.