Detailed Description
template<typename Data>
class Util::DArray< Data >
Dynamically allocatable contiguous array template.
A DArray wraps a dynamically allocated C Array. Unlike an STL std::vector, a DArray cannot be resized after it is allocated. Addresses of elements thus remain constant until de-allocation.
The Array<Data> base class provides bounds checking when compiled in debug mode.
#include <DArray.h>
Public Member Functions | |
| DArray () | |
| Default constructor. More... | |
| DArray (const DArray< Data > &other) | |
| Copy constructor. More... | |
| virtual | ~DArray () |
| Destructor. More... | |
| DArray< Data > & | operator= (const DArray< Data > &other) |
| Assignment operator. More... | |
| void | allocate (int capacity) |
| Allocate the underlying C array. More... | |
| void | deallocate () |
| Dellocate the underlying C array. More... | |
| bool | isAllocated () const |
| Return true if the DArray has been allocated, false otherwise. More... | |
| template<class Archive > | |
| void | serialize (Archive &ar, const unsigned int version) |
| Serialize a DArray to/from an Archive. More... | |
 Public Member Functions inherited from Util::Array< Data > | |
| virtual | ~Array () |
| Destructor. More... | |
| int | capacity () const |
| Return allocated size. More... | |
| void | begin (ArrayIterator< Data > &iterator) |
| Set an iterator to begin this Array. More... | |
| void | begin (ConstArrayIterator< Data > &iterator) const |
| Set a const iterator to begin this Array. More... | |
| Data & | operator[] (int i) |
| Get an element by non-const reference. More... | |
| const Data & | operator[] (int i) const |
| Get an element by const reference. More... | |
| Data * | cArray () |
| Return pointer to underlying C array. More... | |
| const Data * | cArray () const |
| Return pointer to const to underlying C array. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Util::Array< Data > | |
| Array () | |
| Default constructor. More... | |
| Protected Attributes inherited from Util::Array< Data > | |
| Data * | data_ |
| Pointer to an array of Data elements. More... | |
| int | capacity_ |
| Allocated size of the data_ array. More... | |
Constructor & Destructor Documentation
| Util::DArray< Data >::DArray | ( | ) |
| Util::DArray< Data >::DArray | ( | const DArray< Data > & | other | ) |
Copy constructor.
Allocates new memory and copies all elements by value.
- Parameters
-
other the DArray to be copied.
Definition at line 123 of file DArray.h.
References Util::Memory::allocate(), Util::Array< Data >::capacity_, Util::Array< Data >::data_, Util::DArray< Data >::isAllocated(), and UTIL_THROW.
|
virtual |
Destructor.
Deletes underlying C array, if allocated previously.
Definition at line 140 of file DArray.h.
References Util::Array< Data >::capacity_, Util::Array< Data >::data_, and Util::DArray< Data >::isAllocated().
Member Function Documentation
| DArray< Data > & Util::DArray< Data >::operator= | ( | const DArray< Data > & | other | ) |
Assignment operator.
If this DArray is not allocated, allocates and copies all elements.
If this and the other DArray are both allocated, the capacities must be exactly equal. If so, this method copies all elements.
- Parameters
-
other the RHS DArray
Definition at line 159 of file DArray.h.
References Util::DArray< Data >::allocate(), Util::Array< Data >::capacity(), Util::Array< Data >::capacity_, Util::Array< Data >::data_, Util::DArray< Data >::isAllocated(), and UTIL_THROW.
| void Util::DArray< Data >::allocate | ( | int | capacity | ) |
Allocate the underlying C array.
- Parameters
-
capacity number of elements to allocate.
Definition at line 191 of file DArray.h.
References Util::Array< Data >::capacity(), Util::Array< Data >::capacity_, Util::Array< Data >::data_, Util::DArray< Data >::isAllocated(), and UTIL_THROW.
Referenced by Tools::CellList::allocate(), DdMd::CellList::allocate(), Util::AutoCorrStage< Data, Product >::allocate(), Simp::Species::allocateAtoms(), McMd::SpeciesMutator::allocateSpeciesMutator(), McMd::BennettsMethod::BennettsMethod(), Util::CardinalBSpline::CardinalBSpline(), Util::AutoCorr< Data, Product >::clear(), Util::MeanSqDispArray< Data >::clear(), Util::AutoCorrArray< Data, Product >::clear(), Util::Polynomial< T >::differentiate(), Util::Distribution::Distribution(), Simp::GeneralPeriodicExternal::GeneralPeriodicExternal(), McMd::PairList::initialize(), Util::IntDistribution::IntDistribution(), Util::Polynomial< T >::integrate(), Simp::LamellarOrderingExternal::LamellarOrderingExternal(), McMd::NveVvIntegrator::loadParameters(), DdMd::NvtIntegrator::loadParameters(), DdMd::NphIntegrator::loadParameters(), DdMd::NveIntegrator::loadParameters(), DdMd::NptIntegrator::loadParameters(), DdMd::PairEnergyAverage::loadParameters(), DdMd::NvtLangevinIntegrator::loadParameters(), McMd::BennettsMethod::loadParameters(), McMd::NvtLangevinIntegrator::loadParameters(), McMd::Perturbation::loadParameters(), McMd::McMuExchange::loadParameters(), Simp::NucleationExternal::loadParameters(), Simp::PeriodicExternal::loadParameters(), Simp::SimplePeriodicExternal::loadParameters(), McMd::StructureFactorGrid::loadParameters(), Simp::GeneralPeriodicExternal::loadParameters(), DdMd::StructureFactorGrid::loadParameters(), Simp::LamellarOrderingExternal::loadParameters(), Simp::LocalLamellarOrderingExternal::loadParameters(), McMd::BlockRadiusGyration::loadParameters(), DdMd::VanHove::loadParameters(), McMd::VanHove::loadParameters(), Simp::Multiblock::loadSpeciesParam(), Util::DArrayParam< Type >::loadValue(), Simp::LocalLamellarOrderingExternal::LocalLamellarOrderingExternal(), McMd::ReplicaMove::move(), Simp::NucleationExternal::NucleationExternal(), McMd::DCDTrajectoryReader::open(), Util::IntDistribution::operator=(), Util::Distribution::operator=(), Simp::PeriodicExternal::operator=(), Simp::NucleationExternal::operator=(), Util::DArray< Data >::operator=(), McMd::CfbReptationMove::output(), McMd::CfbReptateMove::output(), Simp::PeriodicExternal::PeriodicExternal(), McMd::SmpConfigIo::read(), McMd::NveVvIntegrator::readParameters(), DdMd::NvtIntegrator::readParameters(), DdMd::NveIntegrator::readParameters(), McMd::TypeDistribution::readParameters(), DdMd::NphIntegrator::readParameters(), McMd::CfbReptationMove::readParameters(), DdMd::NptIntegrator::readParameters(), DdMd::PairEnergyAverage::readParameters(), McMd::EndSwapMove::readParameters(), McMd::CfbReptateMove::readParameters(), Util::RadialDistribution::readParameters(), McMd::VelProf::readParameters(), McMd::RingRouseAutoCorr::readParameters(), McMd::McMuExchange::readParameters(), McMd::McMoveManager::readParameters(), McMd::BennettsMethod::readParameters(), DdMd::NvtLangevinIntegrator::readParameters(), McMd::LinearRouseAutoCorr::readParameters(), Util::IntDistribution::readParameters(), McMd::NvtLangevinIntegrator::readParameters(), McMd::LinkMSD::readParameters(), McMd::NvtNhIntegrator::readParameters(), Util::Distribution::readParameters(), McMd::RDF::readParameters(), McMd::NvtDpdVvIntegrator::readParameters(), McMd::CompositionProfile::readParameters(), McMd::NphIntegrator::readParameters(), McMd::Perturbation::readParameters(), McMd::BlockRadiusGyration::readParameters(), Simp::NucleationExternal::readParameters(), Simp::PeriodicExternal::readParameters(), Simp::SimplePeriodicExternal::readParameters(), McMd::StructureFactorGrid::readParameters(), McMd::StructureFactorPGrid::readParameters(), Simp::GeneralPeriodicExternal::readParameters(), DdMd::StructureFactorGrid::readParameters(), Simp::LamellarOrderingExternal::readParameters(), McMd::IntraStructureFactorGrid::readParameters(), Simp::LocalLamellarOrderingExternal::readParameters(), DdMd::VanHove::readParameters(), McMd::VanHove::readParameters(), DdMd::AtomDistributor::readParameters(), McMd::LinearSG::readSpeciesParam(), Simp::Multiblock::readSpeciesParam(), McMd::McCommandManager::readStandardCommand(), McMd::MdCommandManager::readStandardCommand(), McMd::ClusterHistogram::sample(), McMd::StructureFactorPGrid::save(), McMd::Simulation::save(), Util::DArray< Data >::serialize(), McMd::CellList::serialize(), Util::RadialDistribution::setParam(), Util::IntDistribution::setParam(), Util::Distribution::setParam(), McMd::LinkLifeTime::setup(), Simp::SimplePeriodicExternal::SimplePeriodicExternal(), and McMd::McStressAutoCorrelation::~McStressAutoCorrelation().
| void Util::DArray< Data >::deallocate | ( | ) |
Dellocate the underlying C array.
Definition at line 209 of file DArray.h.
References Util::Array< Data >::capacity_, Util::Array< Data >::data_, Util::DArray< Data >::isAllocated(), and UTIL_THROW.
|
inline |
Return true if the DArray has been allocated, false otherwise.
Definition at line 222 of file DArray.h.
References Util::Array< Data >::data_.
Referenced by Util::DArray< Data >::allocate(), Simp::Species::allocateAtoms(), Util::bcast(), Util::DArray< Data >::DArray(), Util::DArray< Data >::deallocate(), Simp::Species::initializeAtomGroupIdArrays(), Simp::Species::isValid(), DdMd::NvtIntegrator::loadParameters(), DdMd::NphIntegrator::loadParameters(), DdMd::NveIntegrator::loadParameters(), DdMd::NptIntegrator::loadParameters(), DdMd::NvtLangevinIntegrator::loadParameters(), Util::DArrayParam< Type >::loadValue(), Util::DArray< Data >::operator=(), DdMd::NvtIntegrator::readParameters(), DdMd::NveIntegrator::readParameters(), DdMd::NphIntegrator::readParameters(), DdMd::NptIntegrator::readParameters(), DdMd::NvtLangevinIntegrator::readParameters(), McMd::NvtNhIntegrator::readParameters(), Util::DArrayParam< Type >::readValue(), Util::recv(), Util::DArrayParam< Type >::saveValue(), Util::send(), Util::DArray< Data >::serialize(), Util::DArrayParam< Type >::writeParam(), and Util::DArray< Data >::~DArray().
| void Util::DArray< Data >::serialize | ( | Archive & | ar, |
| const unsigned int | version | ||
| ) |
Serialize a DArray to/from an Archive.
- Parameters
-
ar archive version archive version id
Definition at line 230 of file DArray.h.
References Util::DArray< Data >::allocate(), Util::Array< Data >::capacity(), Util::Array< Data >::capacity_, Util::Array< Data >::data_, Util::DArray< Data >::isAllocated(), and UTIL_THROW.
The documentation for this class was generated from the following file:
