SG::detail::JaggedVecProxyBase Class Reference

Base class for jagged vector proxies. More...

#include <JaggedVecConversions.h>

Collaboration diagram for SG::detail::JaggedVecProxyBase:

Public Types
using	Elt_t = SG::JaggedVecEltBase
	Type of a jagged vector element. More...
using	Elt_span = std::span< Elt_t >
	A span of elements. More...
using	index_type = typename Elt_t::index_type
	Type used for indexing into a jagged vector. More...

Public Member Functions
	JaggedVecProxyBase (const AuxDataSpanBase &elts, AuxVectorData &container, SG::auxid_t auxid)
	Constructor. More...
Elt_t &	elt (size_t elt_index) noexcept
	Return one jagged vector element (non-const). More...
const Elt_t &	elt (size_t elt_index) const noexcept
	Return one jagged vector element (const). More...
void	resize1 (size_t elt_index, index_type n_new)
	Resize one jagged vector element. More...
void	adjust1 (size_t elt_index, index_type index, int n_add)
	Add or remove payload items from one jagged vector element. More...

Private Attributes
Elt_span	m_elts
	The elements of the jagged vector. More...
AuxVectorData &	m_container
	The container holding the variable. More...
std::variant< IAuxTypeVector *, SG::auxid_t >	m_linkedVec

Detailed Description

Base class for jagged vector proxies.

Proxies are used for modifying elements of a jagged vector. This base class implements the parts that do not depend on payload type.

Definition at line 95 of file JaggedVecConversions.h.

Member Typedef Documentation

Elt_span

using SG::detail::JaggedVecProxyBase::Elt_span = std::span<Elt_t>

A span of elements.

Definition at line 102 of file JaggedVecConversions.h.

Elt_t

using SG::detail::JaggedVecProxyBase::Elt_t = SG::JaggedVecEltBase

Type of a jagged vector element.

Definition at line 99 of file JaggedVecConversions.h.

index_type

using SG::detail::JaggedVecProxyBase::index_type = typename Elt_t::index_type

Type used for indexing into a jagged vector.

Definition at line 105 of file JaggedVecConversions.h.

Constructor & Destructor Documentation

JaggedVecProxyBase()

SG::detail::JaggedVecProxyBase::JaggedVecProxyBase	(	const AuxDataSpanBase &	elts,
		AuxVectorData &	container,
		SG::auxid_t	auxid
	)

Constructor.

Parameters

elts	The elements of the jagged vector.
container	The container holding this variable.
auxid	The aux ID of this variable.

Member Function Documentation

adjust1()

void SG::detail::JaggedVecProxyBase::adjust1	(	size_t	elt_index,
		index_type	index,
		int	n_add
	)

Add or remove payload items from one jagged vector element.

Parameters

elt_index	The index of the element to resize.
index	The index of the payload item within this jagged vector element after the insertion/deletion (in other words, the first element that moves as a result of the change).
n_add	The number of elements to add. May be negative to remove elements.

Definition at line 41 of file JaggedVecConversions.cxx.

{
  // Return right away if there's nothing to do.
  if (n_add == 0) return;
 
  // Find the IAuxTypeVector for the payload variable.
  IAuxTypeVector* linkedVec;
  if (m_linkedVec.index() == 0) {
    // We already have it.
    linkedVec = std::get<0>(m_linkedVec);
  }
  else {
    // Look it up from the container.
    SG::auxid_t auxid = std::get<1>(m_linkedVec);
    linkedVec = m_container.getStore()->linkedVector (auxid);
 
    // Remember it to possibly use again.
    m_linkedVec = linkedVec;
  }
 
  // Indices from the element that we're modifying.
  Elt_t& e = elt(elt_index);
  size_t beg = e.begin(elt_index);
  size_t end = e.end();
 
  // Shift the payload items.
  if (!linkedVec->shift (beg+index, n_add)) {
    m_container.clearCache (linkedVec->auxid());
  }
 
  // Adjust the indices in the jagged vector elements.
  // First the element that we're modifying...
  e = JaggedVecEltBase (end + n_add);
  // .. then all the remaining elements.
  std::ranges::for_each (m_elts | std::views::drop (elt_index+1),
                         JaggedVecEltBase::Shift (n_add));
}

elt() [1/2]

const Elt_t& SG::detail::JaggedVecProxyBase::elt ( size_t  elt_index ) const

noexcept

Return one jagged vector element (const).

Parameters

eltindex

The index of the element.

elt() [2/2]

Elt_t& SG::detail::JaggedVecProxyBase::elt ( size_t  elt_index )

noexcept

Return one jagged vector element (non-const).

Parameters

elt_index

The index of the element.

resize1()

void SG::detail::JaggedVecProxyBase::resize1	(	size_t	elt_index,
		index_type	n_new
	)

Resize one jagged vector element.

Parameters

elt_index	The index of the element to resize.
n_new	The size of the new element.

Any added payload elemnets are default-initialized.

Parameters

eltindex	The index of the element to resize.
n_new	The size of the new element.

Any added payload elemnets are default-initialized.

Definition at line 25 of file JaggedVecConversions.cxx.

{
  int n_old = elt (elt_index).size (elt_index);
  adjust1 (elt_index, n_old, static_cast<int>(n_new) - n_old);
}

Member Data Documentation

m_container

AuxVectorData& SG::detail::JaggedVecProxyBase::m_container

private

The container holding the variable.

Definition at line 160 of file JaggedVecConversions.h.

m_elts

Elt_span SG::detail::JaggedVecProxyBase::m_elts

private

The elements of the jagged vector.

Definition at line 157 of file JaggedVecConversions.h.

m_linkedVec

std::variant<IAuxTypeVector*, SG::auxid_t> SG::detail::JaggedVecProxyBase::m_linkedVec

private

Definition at line 163 of file JaggedVecConversions.h.

---

The documentation for this class was generated from the following files:

• JaggedVecConversions.h
• JaggedVecConversions.cxx