/*
    Copyright (C) 2009 Matthias Kretz <kretz@kde.org>

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) version 3.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.

*/

#ifndef CLUSTERDATA_H
#define CLUSTERDATA_H

#include <vector>
#include "PndFTSCAGBHit.h"
#include "PndFTSArray.h"

#include "PndFTSCAParameters.h"

class PndFTSSpacePointData;

/**
 * Cluster data which keeps history about changes
 *
 * The algorithm doesn't work on this data. Instead the PndFTSCASliceData is created from this.
 */
class PndFTSCAClusterData
{
  public:

    /**
     * Construct PndFTSCAClusterData object from GBHit array.
     */
    PndFTSCAClusterData( const PndFTSCAGBHit *hits, int *offset, int numberOfClusters ) {
      readEvent( hits, offset, numberOfClusters );
    }

    PndFTSCAClusterData() {}

    void readEvent( const PndFTSArray<PndFTSSpacePointData *> &clusters,
        int numberOfClusters, double ClusterZCut );
    void readEvent( const PndFTSCAGBHit *hits, int *offset, int numberOfClusters );

    /**
     * "remove" two clusters and "add" a new one, keeping history.
     */
    void Merge( int index1, int index2 );

    /**
     * "remove" one cluster and "add" two new ones, keeping history.
     */
    //void Split( int index, /* TODO: need some parameters how to split */ );

    // TODO: some access to history of merges and splits

    /**
     * The slice index this data belongs to
     */
    int Slice() const { return fSlice; }

    /**
     * The first row index that contains a cluster.
     */
    int FirstRow() const { return fFirstRow; }

    /**
     * The last row index that contains a cluster.
     */
    int LastRow() const { return fLastRow; }

    /**
     * Return the number of clusters in this slice.
     */
    int NumberOfClusters() const { return fData.size(); }

    /**
     * Return the number of clusters in the given row, for this slice.
     */
    int NumberOfClusters( unsigned int rowIndex ) const { return rowIndex < fNumberOfClusters.size() ? fNumberOfClusters[rowIndex] : 0; }

    /**
     * Return the index of the first cluster in the given row.
     *
     * Supports calls with rowIndex greater than the available number of rows. In that case it
     * returns NumberOfClusters.
     *
     * To iterate over the clusters in one row do:
     * \code
     * PndFTSCAClusterData cd;
     * const int lastClusterIndex = cd.RowOffset( rowIndex + 1 );
     * for ( int hitIndex = cd.RowOffset( rowIndex ); hitIndex < lastClusterIndex; ++hitIndex )
     * \endcode
     */
    int RowOffset( unsigned int rowIndex ) const { return rowIndex < fRowOffset.size() ? fRowOffset[rowIndex] : fData.size(); }

    /**
     * Return the x coordinate of the given cluster.
     */
    float X( int index ) const { assert( index < static_cast<int>( fData.size() ) ); return fData[index].fX; }

    /**
     * Return the y coordinate of the given cluster.
     */
    float Y( int index ) const { assert( index < static_cast<int>( fData.size() ) ); return fData[index].fY; }

    /**
     * Return the z coordinate of the given cluster.
     */
    float Z( int index ) const { assert( index < static_cast<int>( fData.size() ) ); return fData[index].fZ; }

    /**
     * Return the global ID of the given cluster.
     */
    int Id( int index ) const { assert( index < static_cast<int>( fData.size() ) ); return fData[index].fId; }

    /**
     * Return the row number/index of the given cluster.
     */
    int RowNumber( int index ) const { assert( index < static_cast<int>( fData.size() ) ); return fData[index].fRow; }

  private:
    struct Data {
      float fX;
      float fY;
      float fZ;
      int fId;
      int fRow;
    };

    int fSlice;    // the slice index this data belongs to
    int fFirstRow; // see FirstRow()
    int fLastRow;  // see LastRow()
    std::vector<int> fNumberOfClusters; // list of NumberOfClusters per row for NumberOfClusters(int)
    std::vector<int> fRowOffset;        // see RowOffset()
    std::vector<Data> fData; // list of data of clusters
};

typedef PndFTSCAClusterData ClusterData;

#endif // CLUSTERDATA_H