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

Base element of a partitioned structure. More...

#include <Partitions.h>

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

Public Types
using	Data_t = Data
	Type of data stored in the partition. More...
using	Partition_t = Partition< Data >
	This type. More...
using	Area_t = PartitionBase::Area_t
	Type of area. More...
using	Subpartitions_t = std::vector< std::unique_ptr< Partition_t const >>
	Type of list of subpartitions. It needs to preserve polymorphism. More...
Public Types inherited from geo::part::PartitionBase
using	Area_t = AreaOwner::Area_t
using	AreaRangeMember_t = AreaOwner::AreaRangeMember_t
Public Types inherited from geo::part::AreaOwner
using	Area_t = lar::util::simple_geo::Rectangle< double >
	Type of area covered by the partition. More...
using	AreaRangeMember_t = Area_t::Range_t(Area_t::*)
	Type of pointer to Area_t data member of type Range_t. More...

Public Member Functions
	Partition (Area_t const &area)
	Constructor: sets the covered area and no subpartitions. More...
virtual	~Partition ()=default
	Destructor (default, virtual). More...
virtual Data_t *	data () const
	Returns the datum directly stored (nullptr if none). More...
virtual Data_t *	atPoint (double w, double d) const =0
	Returns the (sub)partition including the specified coordinates. 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...
Public Member Functions inherited from geo::part::PartitionBase
	PartitionBase (Area_t const &area)
	Constructor: sets the covered area and no subpartitions. More...
Public Member Functions inherited from geo::part::AreaOwner
	AreaOwner (Area_t const &area)
	Constructor: sets the covered area and no subpartitions. 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
virtual Subpartitions_t const &	parts () const
	Returns a list of all subpartitions. More...
virtual std::string	doDescribe (std::string indent, std::string firstIndent) const
	Returns a description of the partition. More...
Protected Member Functions inherited from geo::part::PartitionBase
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)

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

Detailed Description

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

Base element of a partitioned structure.

Template Parameters

Data	type of data contained in the partition

An area partition is represented by a hierarchy of partition objects, each one containing a non-owning pointer to the data pertaining its area.

The partition classes all derive from this Partition class, which provides access to the data, the area definition and a few utility functions:

• mainly for debugging purposes, the hierarchy can be dumped into a stream by the describe() method
• method walk() applies a specified operation to all the partitions in the hierarchy, in an undefined order
• method atPoint() returns the data of the partition covering the specified location

The hierarchy is such that a partition object (Partition) knows or can find of all the subpartitions it contains, but it does not have any knowledge of the partition containing it (if any).

The partition classes do not provide algorithms to establish their relations.

Definition at line 188 of file Partitions.h.

Member Typedef Documentation

template<typename Data>

using geo::part::Partition< Data >::Area_t = PartitionBase::Area_t

Type of area.

Definition at line 193 of file Partitions.h.

template<typename Data>

using geo::part::Partition< Data >::Data_t = Data

Type of data stored in the partition.

Definition at line 191 of file Partitions.h.

template<typename Data>

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

This type.

Definition at line 192 of file Partitions.h.

template<typename Data>

using geo::part::Partition< Data >::Subpartitions_t = std::vector<std::unique_ptr<Partition_t const>>

Type of list of subpartitions. It needs to preserve polymorphism.

Definition at line 196 of file Partitions.h.

Constructor & Destructor Documentation

template<typename Data>

geo::part::Partition< Data >::Partition ( Area_t const &  area )

inline

Constructor: sets the covered area and no subpartitions.

Definition at line 199 of file Partitions.h.

: PartitionBase(area) {}

template<typename Data>

virtual geo::part::Partition< Data >::~Partition ( )

virtualdefault

Destructor (default, virtual).

Member Function Documentation

template<typename Data>

virtual Data_t* geo::part::Partition< Data >::atPoint ( double  w, double  d  ) const

pure virtual

Returns the (sub)partition including the specified coordinates.

Parameters

w	width coordinate of the point
d	depth coordinate of the point

Returns

a pointer to the partition, or nullptr if none

This method returns a pointer to the datum associated to the area the specified point (w, d) belongs to. The area is searched for among all the included partitions.

Implemented in geo::part::PartitionContainer< Data >, and geo::part::PartitionWithData< Data >.

template<typename Data>

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

inlinevirtual

Returns the datum directly stored (nullptr if none).

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

Definition at line 205 of file Partitions.h.

{ return nullptr; }

template<typename Data>

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

inline

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

inline

Returns a description of the partition.

Definition at line 225 of file Partitions.h.

        { return describe(indent, indent); }

template<typename Data>

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

inlineprotectedvirtual

Returns a description of the partition.

Reimplemented in geo::part::GridPartition< Data >, geo::part::PartitionContainer< Data >, and geo::part::PartitionWithData< Data >.

Definition at line 260 of file Partitions.h.

        { return PartitionBase::describeArea(indent, firstIndent); }

template<typename Data>

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

inline

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

Definition at line 249 of file Partitions.h.

{ return parts().size(); }

template<typename Data>

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

inlineprotectedvirtual

Returns a list of all subpartitions.

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

Definition at line 256 of file Partitions.h.

{ return NoSubparts; }

template<typename Data>

template<typename Pred >

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

inline

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.

{ walk(this, pred); }

template<typename Data >

template<typename Pred >

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

staticprotected

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

Definition at line 804 of file Partitions.h.

                                                                       {
  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>

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

staticprotected

Subpartitions (if any).

Definition at line 253 of file Partitions.h.

---

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

• Partitions.h