GenericConverter.hpp

#ifndef DM_GENERIC_CONVERTER_HPP_INCLUDED
#define DM_GENERIC_CONVERTER_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

#include "DM/config.hpp"
#include "DM/AutoLink.hpp" //enable autolink
#include "DM/Iterator.hpp"
#include "DM/IPoint.hpp"
#include "DM/IAddInfoLayout.hpp"
#include "DM/IIndexMapSet.hpp"
#include "DM/IIndexHelperSet.hpp"
#include "DM/IFilter.hpp"
#include "DM/IColBufferManagerRead.hpp"
#include "DM/IColBufferManagerWrite.hpp"

DM_NAMESPACE_BEGIN

class IClassificationMatrix;

/// \brief provides a set of converter function between DM and generic memory manager structures
namespace GenericConverter
{
   // Iterator typedefs ============================================================================
  typedef ConstIterator<IPoint>       const_iterator_point;     ///< Point iterator

  /// \brief initialize a column buffer manager that it can be used for subsequent converter calls
  ///
  /// \param[in] colBufferManager column buffer manager object for allocating the necessary column buffer objects
  /// \param[in] rowCount         number of rows to reserve
  /// \param[in] layout           defines the attributes (columns of the data frame object) to that should be generated
  /// \param[in] withCoordinates  flag if columns for the coordinates should generated as well
  DM_API void initColBufferManager(IColBufferManagerWrite &colBufferManager, int64_t rowCount, const AddInfoLayoutHandle &layout,  bool withCoordinates = true);

  DM_API int64_t  fillColBuffer(IColBufferManagerWrite &colBufferManager, int64_t rowIdx, const_iterator_point it, const_iterator_point end, FilterHandle filter = FilterHandle());
  DM_API int64_t  fillColBuffer(IColBufferManagerWrite &colBufferManager, int64_t rowIdx, const AddInfoLayoutHandle &mapColumn, const IIndexMapSet &map, IIndexHelperSet &helper, bool invertIndexMap, 
                                const_iterator_point it, const_iterator_point end, FilterHandle filter = FilterHandle());

  /// \brief initialize and fill a column buffer manager 
  /// this function combines initColBufferManager and fillColBuffer calls. The number of rowCounts that is needed to store all data is internally determined and passed to the 
  /// colBufferManager object before the actual filling is performed
  ///
  /// \param[in] colBufferManager column buffer manager object for allocating the necessary column buffer objects
  /// \param[in] it               begin iterator of points
  /// \param[in] end              end iterator of points
  /// \param[in] layout           defines the attributes (columns of the data frame object) to that should be generated
  /// \param[in] withCoordinates  flag if columns for the coordinates should generated as well
  /// \param[in] filter           optional filter to subselect the points
  /// \return number of rows that were filled
  DM_API int64_t  asColBuffer(IColBufferManagerWrite &colBufferManager, const_iterator_point it, const_iterator_point end, const AddInfoLayoutHandle &layout,  bool withCoordinates = true, FilterHandle filter = FilterHandle());
  DM_API int64_t  asColBuffer(IColBufferManagerWrite &colBufferManager, const_iterator_point it, const_iterator_point end, const AddInfoLayoutHandle &layout,  
                              const AddInfoLayoutHandle &mapColumn, const IIndexMapSet &map, IIndexHelperSet &helper, bool invertIndexMap, 
                              bool withCoordinates = true, FilterHandle filter = FilterHandle());


  /// \brief Set attributes from a column buffer object
  DM_API int64_t setFromColBuffer(const_iterator_point it,  const_iterator_point end, const AddInfoLayoutHandle &layout, const IColBufferManagerRead &colBufferManager, FilterHandle filter = FilterHandle());

  DM_API void compareWith(const IColBufferManagerRead &colBufferManager, DM::IClassificationMatrix &classMatrix, const_iterator_point it, const_iterator_point end, 
                          const DM::AddInfoLayoutHandle &mapCol, const DM::IIndexMapSet &map, DM::IIndexHelperSet &helper, bool invertIndexMap, 
                          DM::FilterHandle filter = FilterHandle() );
}

DM_NAMESPACE_END

#endif //DM_GENERIC_CONVERTER_HPP_INCLUDED