geo::part::SortedPartition< Data, Sorter > Class Template Reference

Partition of area sorted across a dimension. More...

#include "Partitions.h"

Inheritance diagram for geo::part::SortedPartition< Data, Sorter >:

Public Types
using	Base_t = PartitionContainer< Data >
	Base class. More...
using	Partition_t = Partition< Data >
	Base type of the partition. More...
using	Sorter_t = Sorter
	Type of sorter being used. More...
using	Data_t = typename Partition_t::Data_t
using	Area_t = typename Partition_t::Area_t
using	Subpartitions_t = typename Base_t::Subpartitions_t
using	AreaRangeMember_t = AreaOwner::AreaRangeMember_t

Public Member Functions
	SortedPartition (Area_t const &area, Subpartitions_t &&subpartitions, Data_t *defData=nullptr, Sorter_t sorter={})
	Constructor: sets the partition. More...
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
Partition_t const *	findPartWithKey (double key) const
	Returns the only partition which could contain the specified key. More...
void	initParts ()
	Performs initialization on the specified subpartition list. More...
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 Partition_t const *	findPart (double w, double d) const =0
	Returns the only partition which could contain the specified width. More...
virtual std::string	doDescribe (std::string indent, std::string firstIndent) const override
	Describes this and each of the subpartitions. 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
Sorter_t	sorter
	Object used for sorting and binary search. More...
Subpartitions_t	myParts
	List of subpartitions. More...

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

Detailed Description

template<typename Data, typename Sorter>
class geo::part::SortedPartition< Data, Sorter >

Partition of area sorted across a dimension.

Template Parameters

Data	type of data contained in the partition
Sorter	type of functor providing comparison of partitions

The sorter is a functor containing comparison functions. It must be compatible with both std::sort() and std::lower_bound() functions. The former requirement implies that the sorter can compare two constant pointers to partitions. The latter also implies that the sorter can compare a constant pointer to partition to a "key" (a real number), and vice versa. The meaning of this comparison is not prescribed; existing implementations interpret that value as a width or depth coordinate.

A copy of the sorter is kept in this partition.

Definition at line 396 of file Partitions.h.

Member Typedef Documentation

template<typename Data , typename Sorter >

using geo::part::SortedPartition< Data, Sorter >::Area_t = typename Partition_t::Area_t

Definition at line 405 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 , typename Sorter >

using geo::part::SortedPartition< Data, Sorter >::Base_t = PartitionContainer<Data>

Base class.

Definition at line 399 of file Partitions.h.

template<typename Data , typename Sorter >

using geo::part::SortedPartition< Data, Sorter >::Data_t = typename Partition_t::Data_t

Definition at line 404 of file Partitions.h.

template<typename Data , typename Sorter >

using geo::part::SortedPartition< Data, Sorter >::Partition_t = Partition<Data>

Base type of the partition.

Definition at line 400 of file Partitions.h.

template<typename Data , typename Sorter >

using geo::part::SortedPartition< Data, Sorter >::Sorter_t = Sorter

Type of sorter being used.

Definition at line 401 of file Partitions.h.

template<typename Data , typename Sorter >

using geo::part::SortedPartition< Data, Sorter >::Subpartitions_t = typename Base_t::Subpartitions_t

Definition at line 406 of file Partitions.h.

Constructor & Destructor Documentation

template<typename Data , typename Sorter >

geo::part::SortedPartition< Data, Sorter >::SortedPartition ( Area_t const &  area, Subpartitions_t &&  subpartitions, Data_t *  defData = nullptr, Sorter_t  sorter = {}  )

inline

Constructor: sets the partition.

Parameters

area	overall area covered
subpartitions	list of subpartitions (pointers)
defData	datum to be returned for points not covered by subpartitions
sorter	instance of the sorter to be used

The subpartitions will be moved from the argument and will be sorted using the comparison contained in the sorter. Note that this will invalidate existing pointers to the sub-partitions.

It is required and assumed that the subpartitions do not overlap and that the points covered by them are a subset of area. Neither of theses requirements is checked.

Definition at line 424 of file Partitions.h.

                          {}
        )
        : Base_t(area, std::move(subpartitions), defData), sorter(sorter)
        { initParts(); }

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()

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 >

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

overrideprotectedvirtualinherited

Describes this and each of the subpartitions.

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

Reimplemented in geo::part::GridPartition< Data >.

Definition at line 854 of file Partitions.h.

References geo::part::describePartitionData(), and part.

Referenced by geo::part::PartitionContainer< Data >::atPoint().

{
  std::string msg = firstIndent + describeIntro();
  if (Base_t::data()) {
    std::ostringstream sstr; 
    sstr << ", and ";
    describePartitionData(sstr, Base_t::data(), indent, "");
    msg += sstr.str();
  }
  
  for (auto const& part: parts()) {
    msg += "\n" + indent + " * ";
    msg += part->describe(indent + "  ", "");
  }
  
  return msg;
} // geo::part::PartitionContainer<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 >

virtual Partition_t const* geo::part::PartitionContainer< Data >::findPart ( double  w, double  d  ) const

protectedpure virtualinherited

Returns the only partition which could contain the specified width.

Implemented in geo::part::GridPartition< Data >.

template<typename Data , typename Sorter >

auto geo::part::SortedPartition< Data, Sorter >::findPartWithKey ( double  key ) const

protected

Returns the only partition which could contain the specified key.

Definition at line 884 of file Partitions.h.

{
  auto pbegin = Base_t::parts().cbegin();
  auto iPart = std::upper_bound(pbegin, Base_t::parts().cend(), key, sorter);
  return (iPart == pbegin)? nullptr: (--iPart)->get();
} // geo::part::SortedPartition<>::findPartWithKey()

template<typename Data , typename Sorter >

void geo::part::SortedPartition< Data, Sorter >::initParts ( )

protected

Performs initialization on the specified subpartition list.

Definition at line 895 of file Partitions.h.

References evd::details::begin(), and evd::details::end().

                                                     {
  /*
   * Initialization tasks:
   * - ensure that the parts are sorted by increasing depth
   * 
   */
  std::sort(Base_t::myParts.begin(), Base_t::myParts.end(), sorter);
  
} // geo::part::SortedPartition<>::initParts()

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 >

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 >

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 , typename Sorter >

Sorter_t geo::part::SortedPartition< Data, Sorter >::sorter

protected

Object used for sorting and binary search.

Definition at line 435 of file Partitions.h.

---

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

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