geo::part::GridPartition< Data > Class Template Reference

A container of partitions organised in a width/depth rectangular grid. More...

#include "Partitions.h"

Inheritance diagram for geo::part::GridPartition< Data >:

Public Types
using	Partition_t = Partition< Data >
	Base type of the partition. More...
using	Base_t = PartitionContainer< Data >
	Base class. More...
using	Data_t = typename Partition_t::Data_t
	Type of contained data. More...
using	Area_t = typename Partition_t::Area_t
	Type of covered area. More...
using	Subpartitions_t = typename Base_t::Subpartitions_t
using	AreaRangeMember_t = AreaOwner::AreaRangeMember_t

Public Member Functions
	GridPartition (Area_t const &area, Subpartitions_t &&subpartitions, unsigned int nDepthPartitions, unsigned int nWidthPartitions, Data_t *defData=nullptr)
	Creates a partition with a grid of subpartitions. More...
	GridPartition (Area_t const &area, Subpartitions_t &&subpartitions, unsigned int nDepthPartitions, Data_t *defData=nullptr)
virtual Data_t *	atPoint (double w, double d) const override
	Returns stored datum only if point is covered, nullptr otherwise. More...
virtual Data_t *	data () const override
	Returns the datum directly stored (nullptr if none). More...
std::string	describe (std::string indent, std::string firstIndent) const
	Returns a description of the partition. More...
std::string	describe (std::string indent="") const
	Returns a description of the partition. More...
template<typename Pred >
void	walk (Pred &&pred) const
	Applies pred to all partitions. More...
std::size_t	nParts () const
	Returns the number of subparts in the partition (0 if simple element). More...
bool	contains (double w, double d) const
	Returns whether the specified point is covered by this object. More...
Area_t const &	area () const
	Returns the covered area. More...
template<typename Stream >
void	dumpArea (Stream &&out) const
	Output the owned area into an output stream. More...

Protected Member Functions
std::size_t	size () const
	Returns the number of contained subpartitions. More...
virtual Subpartitions_t const &	parts () const override
	Returns a list of the subpartitions owned. More...
virtual std::string	describeIntro () const
	Introduction to the description of the subpartitions. More...
std::string	describeArea (std::string indent, std::string firstIndent) const
	Returns a description of the partition area. More...

Static Protected Member Functions
template<typename Pred >
static void	walk (Partition_t const *start, Pred &&pred)

Protected Attributes
Subpartitions_t	myParts
	List of subpartitions. More...

Static Protected Attributes
static Subpartitions_t const	NoSubparts
	Subpartitions (if any). More...

Private Member Functions
std::size_t	nWidthParts () const
	Number of partitions on width direction. More...
std::size_t	nDepthParts () const
auto	part (std::size_t iDepth, std::size_t iWidth) -> decltype(auto)
auto	part (std::size_t iDepth, std::size_t iWidth) const -> decltype(auto)
virtual Partition_t const *	findPart (double w, double d) const override
	Returns the only partition which could contain the specified depth. More...
std::vector< double >	computeWidthSeps (unsigned int nD, unsigned int nW) const
	Computes and returns width separation levels proper for widthSeps. More...
std::vector< double >	computeDepthSeps (unsigned int nD, unsigned int nW) const
	Computes and returns width separation levels proper for depthSeps. More...
virtual std::string	doDescribe (std::string indent, std::string firstIndent) const override
	Prints the information about the partition grid. More...

Static Private Member Functions
template<PartitionBase::AreaRangeMember_t Range, typename BeginIter , typename EndIter >
static std::vector< double >	detectSeparators (BeginIter b, EndIter e, std::size_t const nGroups, std::size_t const startDelta, std::size_t const stride)

Private Attributes
std::vector< double >	widthSeps
	Separators for width dimension. More...
std::vector< double >	depthSeps
	Separators for depth dimension. More...

Detailed Description

template<typename Data>
class geo::part::GridPartition< Data >

A container of partitions organised in a width/depth rectangular grid.

Definition at line 514 of file Partitions.h.

Member Typedef Documentation

template<typename Data >

using geo::part::GridPartition< Data >::Area_t = typename Partition_t::Area_t

Type of covered area.

Definition at line 521 of file Partitions.h.

using geo::part::PartitionBase::AreaRangeMember_t = AreaOwner::AreaRangeMember_t

inherited

Definition at line 147 of file Partitions.h.

template<typename Data >

using geo::part::GridPartition< Data >::Base_t = PartitionContainer<Data>

Base class.

Definition at line 517 of file Partitions.h.

template<typename Data >

using geo::part::GridPartition< Data >::Data_t = typename Partition_t::Data_t

Type of contained data.

Definition at line 520 of file Partitions.h.

template<typename Data >

using geo::part::GridPartition< Data >::Partition_t = Partition<Data>

Base type of the partition.

Definition at line 516 of file Partitions.h.

template<typename Data >

using geo::part::GridPartition< Data >::Subpartitions_t = typename Base_t::Subpartitions_t

Definition at line 522 of file Partitions.h.

Constructor & Destructor Documentation

template<typename Data >

geo::part::GridPartition< Data >::GridPartition	(	Area_t const &	area,
		Subpartitions_t &&	subpartitions,
		unsigned int	nDepthPartitions,
		unsigned int	nWidthPartitions,
		Data_t *	defData = nullptr
	)

Creates a partition with a grid of subpartitions.

Parameters

area	total area covered by this partition
subpartitions	all subpartitions, row by row
nDepthPartitions	number of partitions on depth direction ("rows")
nWidthPartitions	number of partitions on width direction ("columns")
defData	partition data for areas not covered by subpartitions

The content of the collection of subpartitions is stolen. The subpartitions in that collection are expected to be organized by row: (0;0), (0,1), (0,2)... where the first index spans nDepthPartitions values and the second one spans nWidthPartitions values.

Definition at line 934 of file Partitions.h.

References geo::part::PartitionContainer< Data >::size().

  : Base_t(area, std::move(subpartitions), defData)
  , widthSeps(computeWidthSeps(nDepthPartitions, nWidthPartitions))
  , depthSeps(computeDepthSeps(nDepthPartitions, nWidthPartitions))
{
  assert(nWidthPartitions * nDepthPartitions == Base_t::size());
} // geo::part::GridPartition<Data>::GridPartition()

template<typename Data >

geo::part::GridPartition< Data >::GridPartition	(	Area_t const &	area,
		Subpartitions_t &&	subpartitions,
		unsigned int	nDepthPartitions,
		Data_t *	defData = nullptr
	)

Constructor: autodetects nWidthPartitions from number of subpartitions.

Definition at line 949 of file Partitions.h.

References geo::part::GridPartition< Data >::doDescribe().

  : GridPartition(
    area, std::move(subpartitions), nDepthPartitions,
    (nDepthPartitions? subpartitions.size()/nDepthPartitions: 0),
    defData
    )
  {}

Member Function Documentation

Area_t const& geo::part::AreaOwner::area ( ) const

inlineinherited

Returns the covered area.

Definition at line 56 of file Partitions.h.

References geo::part::AreaOwner::myArea.

Referenced by geo::part::AreaOwner::contains(), geo::part::AreaOwner::dumpArea(), makeTPCPartitionElement(), geo::part::details::RangeLowerBoundExtractor< Range >::operator()(), and geo::part::details::PartitionRangeLowerBoundExtractor< Range >::operator()().

{ return myArea; }

template<typename Data >

auto geo::part::PartitionContainer< Data >::atPoint ( double  w, double  d  ) const

overridevirtualinherited

Returns stored datum only if point is covered, nullptr otherwise.

Reimplemented from geo::part::PartitionWithData< Data >.

Definition at line 841 of file Partitions.h.

References geo::part::PartitionContainer< Data >::doDescribe(), and part.

{
  if (!Base_t::contains(w, d)) return nullptr; // not our point at all
  // it's ours; see if it belongs to a subpart
  auto part = findPart(w, d);
  return part? part->atPoint(w, d): Base_t::data();
} // geo::part::PartitionContainer<Data>::atPoint()

template<typename Data >

std::vector< double > geo::part::GridPartition< Data >::computeDepthSeps ( unsigned int  nD, unsigned int  nW  ) const

private

Computes and returns width separation levels proper for depthSeps.

Definition at line 1013 of file Partitions.h.

References geo::part::PartitionContainer< Data >::parts().

Referenced by geo::part::GridPartition< Data >::computeWidthSeps().

{
  return detectSeparators<&Area_t::depth>
    (Base_t::parts().cbegin(), Base_t::parts().cend(), nD, nW, 1U);
} // geo::part::GridPartition<Data>::computeDepthSeps()

template<typename Data >

std::vector< double > geo::part::GridPartition< Data >::computeWidthSeps ( unsigned int  nD, unsigned int  nW  ) const

private

Computes and returns width separation levels proper for widthSeps.

Definition at line 1004 of file Partitions.h.

References geo::part::GridPartition< Data >::computeDepthSeps(), and geo::part::PartitionContainer< Data >::parts().

Referenced by geo::part::GridPartition< Data >::findPart().

{
  return detectSeparators<&Area_t::width>
    (Base_t::parts().cbegin(), Base_t::parts().cend(), nW, 1U, nW);
} // geo::part::GridPartition<Data>::computeWidthSeps()

bool geo::part::AreaOwner::contains ( double  w, double  d  ) const

inlineinherited

Returns whether the specified point is covered by this object.

Definition at line 52 of file Partitions.h.

References geo::part::AreaOwner::area(), and lar::util::simple_geo::Rectangle< Data >::contains().

        { return area().contains(w, d); }

template<typename Data >

virtual Data_t* geo::part::PartitionWithData< Data >::data ( ) const

inlineoverridevirtualinherited

Returns the datum directly stored (nullptr if none).

Reimplemented from geo::part::Partition< Data >.

Definition at line 289 of file Partitions.h.

Referenced by geo::part::GridPartition< Data >::doDescribe().

{ return myData; }

template<typename Data>

std::string geo::part::Partition< Data >::describe ( std::string  indent, std::string  firstIndent  ) const

inlineinherited

Returns a description of the partition.

Definition at line 221 of file Partitions.h.

        { return doDescribe(indent, firstIndent); }

template<typename Data>

std::string geo::part::Partition< Data >::describe ( std::string  indent = "" ) const

inlineinherited

Returns a description of the partition.

Definition at line 225 of file Partitions.h.

References art::detail::describe().

        { return describe(indent, indent); }

std::string geo::part::PartitionBase::describeArea ( std::string  indent, std::string  firstIndent  ) const

inlineprotectedinherited

Returns a description of the partition area.

Definition at line 606 of file Partitions.h.

References geo::part::AreaOwner::dumpArea(), and part.

Referenced by geo::part::Partition< Data >::doDescribe(), and geo::part::GridPartition< Data >::part().

{
  std::ostringstream sstr;
  sstr << firstIndent << "partition covers ";
  dumpArea(sstr);
  return sstr.str();
} // geo::part::PartitionBase::describeArea()

template<typename Data >

std::string geo::part::PartitionContainer< Data >::describeIntro ( ) const

protectedvirtualinherited

Introduction to the description of the subpartitions.

Definition at line 875 of file Partitions.h.

References util::flags::to_string().

Referenced by geo::part::GridPartition< Data >::doDescribe().

                                                               {
  return std::to_string(parts().size()) + " subpartitions";
} // geo::part::PartitionContainer<Data>::describeIntro()

template<typename Data >

template<geo::part::AreaOwner::AreaRangeMember_t Range, typename BeginIter , typename EndIter >

std::vector< double > geo::part::GridPartition< Data >::detectSeparators ( BeginIter  b, EndIter  e, std::size_t const  nGroups, std::size_t const  startDelta, std::size_t const  stride  )

staticprivate

Definition at line 1025 of file Partitions.h.

References geo::part::Partition< Data >::nParts(), and geo::part::GridPartition< Data >::part().

  {
  /*
   * The iterators are better be random access.
   * The range [b,e[ is considered to be a 2D table stored row after row.
   * This function can operate on rows or columns, given the proper arguments.
   * 
   * The full range is split in nGroups "groups" (e.g. rows or columns).
   * Each group g starts at the element g x startDelta.
   * All members of that group are stride elements far from each other.
   * 
   * Be the table of size (d x w).
   * To process data row by row:
   * - the group is a row
   * - the number of groups is the number of rows: nGroups = d
   * - each group will have (d x w)/nGroups = w elements
   * - the start offset is the number of group times the size of it:
   *   startDelta = w
   * - the elements are contiguous: stride = 1
   * 
   * To process data column by column:
   * - the group is a column
   * - the number of groups is the number of columns: nGroups = w
   * - each group will have (d x w)/nGroups = d elements
   * - the start offset matches the number of group: startDelta = 1
   * - the elements are separated by a full row: stride = w
   * 
   */
  // the separator is on the lower bound of selected range of the partition area
  
  static_assert(details::is_partition_ptr_iterator<BeginIter>(),
    "Begin iterator does not point to a pointer to partition type");
  
  details::PartitionRangeLowerBoundExtractor<Range> lowerBound;
  
  std::size_t const nParts = std::distance(b, e);
  std::size_t const nPartsInGroup = nParts / nGroups;
  
  auto const part
    = [b](std::size_t index){ return std::next(b, index)->get(); };
  
  std::vector<double> seps(nGroups);
  for (size_t g = 0; g < nGroups; ++g) {
  
    double& sep = seps[g];
    
    // indices of an element in the previous and next group, respectively
    std::size_t index = g * startDelta;
    sep = lowerBound(part(index));
    
    std::size_t const iend = index + nPartsInGroup * stride;
    while ((index += stride) < iend) {
      double const l = lowerBound(part(index));
      if (sep > l) sep = l;
    } // while (element)
    
  } // while (groups)
  return seps;
} // geo::part::GridPartition<Data>::detectSeparators()

template<typename Data >

std::string geo::part::GridPartition< Data >::doDescribe ( std::string  indent, std::string  firstIndent  ) const

overrideprivatevirtual

Prints the information about the partition grid.

Reimplemented from geo::part::PartitionContainer< Data >.

Definition at line 965 of file Partitions.h.

References geo::part::PartitionWithData< Data >::data(), geo::part::PartitionContainer< Data >::describeIntro(), geo::part::describePartitionData(), geo::part::GridPartition< Data >::nDepthParts(), geo::part::GridPartition< Data >::nWidthParts(), and geo::part::GridPartition< Data >::part().

Referenced by geo::part::GridPartition< Data >::GridPartition().

{
  std::ostringstream sstr; 
  sstr << firstIndent << Base_t::describeIntro()
    << " in a (WxD) = " << nWidthParts() << " x " << nDepthParts() << " grid";
  if (Base_t::data()) {
    sstr << ", and ";
    describePartitionData(sstr, Base_t::data(), indent, "");
  }
  for (std::size_t iDepth = 0; iDepth < nDepthParts(); ++iDepth) {
    for (std::size_t iWidth = 0; iWidth < nWidthParts(); ++iWidth) {
      sstr << "\n" << indent << " [" << iDepth << "][" << iWidth << "] "
        << part(iDepth, iWidth)->describe(indent + "  ", "");
    } // for width
  } // for depth
  
  return sstr.str();
} // geo::part::GridPartition<Data>::doDescribe()

template<typename Stream >

void geo::part::AreaOwner::dumpArea ( Stream &&  out ) const

inlineinherited

Output the owned area into an output stream.

Definition at line 60 of file Partitions.h.

References geo::part::AreaOwner::area().

Referenced by geo::part::PartitionBase::describeArea().

{ std::forward<Stream>(out) << area(); }

template<typename Data >

auto geo::part::GridPartition< Data >::findPart ( double  w, double  d  ) const

overrideprivatevirtual

Returns the only partition which could contain the specified depth.

Implements geo::part::PartitionContainer< Data >.

Definition at line 987 of file Partitions.h.

References geo::part::GridPartition< Data >::computeWidthSeps(), d, geo::part::GridPartition< Data >::depthSeps, geo::part::GridPartition< Data >::part(), w, and geo::part::GridPartition< Data >::widthSeps.

{
  auto const iWidth = std::upper_bound(widthSeps.cbegin(), widthSeps.cend(), w);
  if (iWidth == widthSeps.cbegin()) return nullptr;
  auto const iDepth = std::upper_bound(depthSeps.cbegin(), depthSeps.cend(), d);
  if (iDepth == depthSeps.cbegin()) return nullptr;
  return part(
    std::distance(depthSeps.cbegin(), iDepth) - 1U,
    std::distance(widthSeps.cbegin(), iWidth) - 1U
    ).get();
} // geo::part::GridPartition<Data>::findPart()

template<typename Data >

std::size_t geo::part::GridPartition< Data >::nDepthParts ( ) const

inlineprivate

Definition at line 561 of file Partitions.h.

Referenced by geo::part::GridPartition< Data >::doDescribe().

{ return depthSeps.size(); }

template<typename Data>

std::size_t geo::part::Partition< Data >::nParts ( ) const

inlineinherited

Returns the number of subparts in the partition (0 if simple element).

Definition at line 249 of file Partitions.h.

Referenced by geo::part::GridPartition< Data >::detectSeparators().

{ return parts().size(); }

template<typename Data >

std::size_t geo::part::GridPartition< Data >::nWidthParts ( ) const

inlineprivate

Number of partitions on width direction.

Number of partitions on depth direction.

Definition at line 559 of file Partitions.h.

Referenced by geo::part::GridPartition< Data >::doDescribe().

template<typename Data >

auto geo::part::GridPartition< Data >::part ( std::size_t  iDepth, std::size_t  iWidth  ) -> decltype(auto)

inlineprivate

Definition at line 563 of file Partitions.h.

Referenced by geo::part::GridPartition< Data >::detectSeparators(), geo::part::GridPartition< Data >::doDescribe(), and geo::part::GridPartition< Data >::findPart().

        { return Base_t::parts()[iDepth * nWidthParts() + iWidth]; }

template<typename Data >

auto geo::part::GridPartition< Data >::part ( std::size_t  iDepth, std::size_t  iWidth  ) const -> decltype(auto)

inlineprivate

Definition at line 565 of file Partitions.h.

References geo::part::PartitionBase::describeArea(), and e.

        { return Base_t::parts()[iDepth * nWidthParts() + iWidth]; }

template<typename Data >

virtual Subpartitions_t const& geo::part::PartitionContainer< Data >::parts ( ) const

inlineoverrideprotectedvirtualinherited

Returns a list of the subpartitions owned.

Reimplemented from geo::part::Partition< Data >.

Definition at line 343 of file Partitions.h.

Referenced by geo::part::GridPartition< Data >::computeDepthSeps(), and geo::part::GridPartition< Data >::computeWidthSeps().

{ return myParts; }

template<typename Data >

std::size_t geo::part::PartitionContainer< Data >::size ( ) const

inlineprotectedinherited

Returns the number of contained subpartitions.

Definition at line 340 of file Partitions.h.

Referenced by geo::part::GridPartition< Data >::GridPartition().

{ return parts().size(); }

template<typename Data>

template<typename Pred >

void geo::part::Partition< Data >::walk ( Pred &&  pred ) const

inlineinherited

Applies pred to all partitions.

Template Parameters

Pred	a predicate type

Parameters

pred	the predicate to be applied

The predicate pred is applied to this partition first, and then to all subpartitions in no specified order.

The predicate is any object behaving like a unary function of signature:

void predicate(Partition<Data> const& part);

If the predicate returns a value, that value is ignored. The predicate is forwarded while "walking" through the partitions.

Definition at line 246 of file Partitions.h.

References geo::part::Partition< Data >::walk().

Referenced by geo::DriftPartitions::computeCoverage(), and geo::part::Partition< Data >::walk().

{ walk(this, pred); }

template<typename Data >

template<typename Pred >

void geo::part::Partition< Data >::walk ( Partition_t const *  start, Pred &&  pred  )

staticprotectedinherited

Applies pred to start partition first, and then to all subpartitions.

Definition at line 804 of file Partitions.h.

References geo::part::PartitionWithData< Data >::doDescribe(), and geo::part::Partition< Data >::parts().

                                                                       {
  if (!start) return;
  pred(*start);
  
  // recursive implementation
  for (auto const& subPart: start->parts())
    subPart->walk(std::forward<Pred>(pred));
  
} // geo::part::Partition<Data>::walk()

Member Data Documentation

template<typename Data >

std::vector<double> geo::part::GridPartition< Data >::depthSeps

private

Separators for depth dimension.

Definition at line 556 of file Partitions.h.

Referenced by geo::part::GridPartition< Data >::findPart().

template<typename Data >

Subpartitions_t geo::part::PartitionContainer< Data >::myParts

protectedinherited

List of subpartitions.

Definition at line 337 of file Partitions.h.

template<typename Data>

geo::part::Partition< Data >::Subpartitions_t const geo::part::Partition< Data >::NoSubparts

staticprotectedinherited

Subpartitions (if any).

Definition at line 253 of file Partitions.h.

template<typename Data >

std::vector<double> geo::part::GridPartition< Data >::widthSeps

private

Separators for width dimension.

Definition at line 555 of file Partitions.h.

Referenced by geo::part::GridPartition< Data >::findPart().

---

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

• larcorealg/v1_24_01/source/larcorealg/Geometry/Partitions.h