codac2::CtcInter<> Class Reference

Default CtcInter specialization for box contractors. More...

#include <codac2_CtcInter.h>

Inheritance diagram for codac2::CtcInter<>:

Collaboration diagram for codac2::CtcInter<>:

Public Member Functions
	CtcInter (Index n)
	Builds a neutral intersection contractor with a prescribed domain size.
size_t	nb () const
	Returns the number of stored contractors.
void	contract (X &... x) const
	Contracts the given domain(s) by applying all stored contractors in sequence.
CtcInter< X... > &	operator&= (const C &c)
	Appends a contractor to the current intersection.
Public Member Functions inherited from codac2::CtcInter< IntervalVector >
	CtcInter (Index n)
	Builds a neutral intersection contractor with a prescribed domain size.
size_t	nb () const
	Returns the number of stored contractors.
void	contract (X &... x) const
	Contracts the given domain(s) by applying all stored contractors in sequence.
CtcInter< X... > &	operator&= (const C &c)
	Appends a contractor to the current intersection.

Protected Attributes
Collection< CtcBase< X... > >	_ctcs
	Internal collection of contractors composing the intersection.
Protected Attributes inherited from codac2::CtcInter< IntervalVector >
Collection< CtcBase< X... > >	_ctcs
	Internal collection of contractors composing the intersection.

Detailed Description

Default CtcInter specialization for box contractors.

CtcInter<> is an alias-like specialization inheriting from CtcInter<IntervalVector>.

Constructor & Destructor Documentation

CtcInter()

codac2::CtcInter< X >::CtcInter ( Index n )

inlineexplicit

Builds a neutral intersection contractor with a prescribed domain size.

This constructor is mainly useful when building a contractor incrementally with operator&=. Otherwise it has no effect.

Parameters

n	Dimension of the contracted object.

Note

When X... is Interval, the size must be 1.

        : Ctc<CtcInter<X...>,X...>(n)
      {
        if constexpr(std::is_same_v<X...,Interval>)
        {
          assert(n == 1);
        }
      }

Member Function Documentation

nb()

size_t codac2::CtcInter< X >::nb ( ) const

inline

Returns the number of stored contractors.

Returns

Size of the internal contractor collection.

      {
        return _ctcs.size();
      }

contract()

void codac2::CtcInter< X >::contract ( X &... x ) const

inline

Contracts the given domain(s) by applying all stored contractors in sequence.

The domains are updated in place. If one contractor empties one of the domains, the remaining contractors are not evaluated.

Parameters

x	Domain(s) to contract.

      {
        for(const auto& ci : _ctcs)
        {
          ci->contract(x...);
          if((x.is_empty() | ...))
            return;
        }
      }

operator&=()

CtcInter< X... > & codac2::CtcInter< X >::operator&= ( const C & c )

inline

Appends a contractor to the current intersection.

The contractor is added at the end of the internal sequence, so it will be applied after the already stored ones.

Template Parameters

C	Type of the contractor or contractor pointer.

Parameters

c	Contractor to append.

Returns

A reference to *this.

      {
        assert_release(size_of(c) == this->size());
        _ctcs.push_back(c);
        return *this;
      }

---

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

• /home/simon/codac-simon/src/core/contractors/codac2_CtcInter.h