CombinationsIterator Class Reference

#include <CombinationsIterator.h>

Collaboration diagram for CombinationsIterator:

Public Types
using	iterator_category = std::forward_iterator_tag
using	difference_type = std::ptrdiff_t
using	value_type = HypoJetVector
using	reference = HypoJetVector&
using	pointer = HypoJetVector*

Public Member Functions
	CombinationsIterator (std::size_t k, const HypoJetVector &input_vals, bool end=false)
	CombinationsIterator ()
reference	operator* ()
pointer	operator-> ()
CombinationsIterator &	operator++ ()
CombinationsIterator	operator++ (int)
CombinationsIterator	endIter () const

Private Attributes
CombinationsGenerator	m_gen {0,0}
std::size_t	m_k {0}
HypoJetVector	m_input_vals
HypoJetVector	m_vals
bool	m_end {false}

Friends
std::ostream &	operator<< (std::ostream &os, const CombinationsIterator &iter)
bool	operator== (const CombinationsIterator &a, const CombinationsIterator &b)
bool	operator!= (const CombinationsIterator &a, const CombinationsIterator &b)

Detailed Description

Definition at line 26 of file CombinationsIterator.h.

Member Typedef Documentation

difference_type

using CombinationsIterator::difference_type = std::ptrdiff_t

Definition at line 30 of file CombinationsIterator.h.

iterator_category

using CombinationsIterator::iterator_category = std::forward_iterator_tag

Definition at line 29 of file CombinationsIterator.h.

pointer

using CombinationsIterator::pointer = HypoJetVector*

Definition at line 33 of file CombinationsIterator.h.

reference

using CombinationsIterator::reference = HypoJetVector&

Definition at line 32 of file CombinationsIterator.h.

value_type

using CombinationsIterator::value_type = HypoJetVector

Definition at line 31 of file CombinationsIterator.h.

Constructor & Destructor Documentation

CombinationsIterator() [1/2]

CombinationsIterator::CombinationsIterator	(	std::size_t	k,
		const HypoJetVector &	input_vals,
		bool	end = false )

Definition at line 21 of file CombinationsIterator.cxx.

                                :
  m_gen{CombinationsGenerator(iv.size(), k)},
  m_k{k},
  m_input_vals{iv},
  m_end{end}
{
  auto indices = m_gen.get();
  std::transform(indices.cbegin(),
         indices.cend(),
         std::back_inserter(m_vals),
         [iv = this->m_input_vals](const auto& ind) {
           return iv.at(ind);
         });
}

CombinationsIterator() [2/2]

CombinationsIterator::CombinationsIterator ( )

inline

Definition at line 41 of file CombinationsIterator.h.

{}

Member Function Documentation

endIter()

CombinationsIterator CombinationsIterator::endIter

(

)

const

Definition at line 39 of file CombinationsIterator.cxx.

                                                         {
  return CombinationsIterator(m_k, m_input_vals, true);
}

operator*()

reference CombinationsIterator::operator* ( )

inline

Definition at line 44 of file CombinationsIterator.h.

{return m_vals;}

operator++() [1/2]

CombinationsIterator & CombinationsIterator::operator++ ( )

inline

Definition at line 50 of file CombinationsIterator.h.

                                     {
    m_end = m_gen.bump();
    auto indices = m_gen.get();
 
    // overwrite m_vals according to the combinations indicies
    std::transform(indices.cbegin(),
           indices.cend(),
           m_vals.begin(),
           [iv = this->m_input_vals](const auto& ind) {
             return iv.at(ind);
           });
    
    return *this;
  }

operator++() [2/2]

CombinationsIterator CombinationsIterator::operator++ ( int )

inline

Definition at line 66 of file CombinationsIterator.h.

                                       {
    CombinationsIterator tmp = *this;
    ++(*this);
    return tmp;
  }

operator->()

pointer CombinationsIterator::operator-> ( )

inline

Definition at line 47 of file CombinationsIterator.h.

{return &m_vals;}

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const CombinationsIterator & a, const CombinationsIterator & b )

friend

Definition at line 88 of file CombinationsIterator.h.

                                            {
    return !(a==b);
  }

operator<<

std::ostream & operator<< ( std::ostream & os, const CombinationsIterator & iter )

friend

Definition at line 3 of file CombinationsIterator.cxx.

                                                                           {
  os << std::boolalpha
     << " generator: " << iter.m_gen
     << " end: "  << iter.m_end
     << " input vals: ";
  for(const auto& hj : iter.m_input_vals) {
    os  << static_cast<const void*>(hj.get()) << '\n';
  }
 
  os << '\n' <<" vals: ";
 
  for(const auto& hj : iter.m_vals) {
    os  << static_cast<const void*>(hj.get()) << '\n';
  }
 
  return os;
}

operator==

bool operator== ( const CombinationsIterator & a, const CombinationsIterator & b )

friend

Definition at line 77 of file CombinationsIterator.h.

                                            {
  return a.m_end == b.m_end and
    a.m_k == b.m_k and
    a.m_input_vals == b.m_input_vals;
    
  
  }

Member Data Documentation

m_end

bool CombinationsIterator::m_end {false}

private

Definition at line 101 of file CombinationsIterator.h.

{false};

m_gen

CombinationsGenerator CombinationsIterator::m_gen {0,0}

private

Definition at line 95 of file CombinationsIterator.h.

{0,0};

m_input_vals

HypoJetVector CombinationsIterator::m_input_vals

private

Definition at line 98 of file CombinationsIterator.h.

m_k

std::size_t CombinationsIterator::m_k {0}

private

Definition at line 96 of file CombinationsIterator.h.

{0};

m_vals

HypoJetVector CombinationsIterator::m_vals

private

Definition at line 99 of file CombinationsIterator.h.

---

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

• CombinationsIterator.h
• CombinationsIterator.cxx