/* linbox/blackbox/matrix/sparsematrix/sparse-tpl-matrix.h
 * Copyright (c) Linbox
 * ========LICENCE========
 * This file is part of the library LinBox.
 *
 * LinBox is free software: you can redistribute it and/or modify
 * it under the terms of the  GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * ========LICENCE========

 * Written by Rich Seagraves <seagrave@cis.udel.edu>
 * with mods by bds
 */

/** @file matrix/sparsematrix/sparse-tpl-matrix.h
 * @ingroup sparsematrix
 * @brief
 * A <code>SparseMatrix<_Field, SparseMatrixFormat::TPL ></code>
 * is a vector of (i,j,value) triples.
 *
 * This is a variant of COO format.
 */


#ifndef __LINBOX_matrix_sparsematrix_sparse_tpl_matrix_H
#define __LINBOX_matrix_sparsematrix_sparse_tpl_matrix_H

#include <algorithm>
#include <iostream>
#include "linbox/linbox-config.h"
#include "linbox/util/debug.h"
#include "linbox/util/field-axpy.h"
#include "linbox/blackbox/blackbox-interface.h"
#include "linbox/blackbox/blockbb.h"
#include "linbox/field/hom.h"
#include "linbox/matrix/matrix-domain.h"

#include <vector>

namespace LinBox
{

	/** \brief Sparse Matrix in Triples storage
	 *
	 \ingroup blackbox
	 * Sparse matrix representation which stores nonzero entries by i,j,value triples.
	 */
  template<class Field_>
  class SparseMatrix<Field_, SparseMatrixFormat::TPL> : public BlackboxInterface {

	public:
	typedef Field_ Field;
	typedef typename MatrixDomain<Field>::Matrix Matrix;
	typedef typename Field::Element Element;
	typedef SparseMatrix<Field,SparseMatrixFormat::TPL> Self_t;
	typedef size_t Index; // would prefer a signed type
	enum sortPolicy {unsorted, cacheOpt, rowMajor, colMajor};

	// Default constructor.
	// SparseMatrix();

	SparseMatrix(const SparseMatrix & B);

	SparseMatrix(const Field& F, std::istream& in);
	SparseMatrix(MatrixStream<Field>& ms);

	std::istream& read(std::istream& in);

	template<class Format>
	std::ostream& write(std::ostream& out, Format f) const;

	std::ostream& write(std::ostream& out) const;


	~SparseMatrix();

	SparseMatrix(const Field& F, Index r = 0, Index c = 0);

	// (re)initialize the matrix.  Any prior entries are abandoned.
	SparseMatrix& init(const Field& F, Index r = 0, Index c = 0);

	// need cstor from matrix stream, read, write

	// Element e is added in the i,j position.
	const Element& setEntry(Index i, Index j, const Element & e);

	/// Establish triples order.  Use after setEntry's, before any applies.
	void finalize(sortPolicy s = cacheOpt);

	// Element e is set to the i,j entry.
	Element& getEntry(Element& e, Index i, Index j) const;

	const Element /* & */getEntry(Index i, Index j) const
	{
		Element x ;
		getEntry(x,i,j);
		return x;
	}

	/// Mul with this on left: Y <- AX. Requires conformal shapes.
	template<class Mat1, class Mat2>
	Mat1 & applyLeft(Mat1 &Y, const Mat2 &X) const;
	//Matrix & applyLeft(Matrix &Y, const Matrix &X) const;

	/// Mul with this on right: Y <- XA. Requires conformal shapes.
	template<class Mat1, class Mat2>
	Mat1 & applyRight(Mat1 &Y, const Mat2 &X) const;
	//Matrix & applyRight(Matrix &Y, const Matrix &X) const;

	/** y <- A x.
	 *
	 *  Performance will generally be best if A is in cacheOpt order,
	 *  and rowMajor, colMajor orders are generally better than random.
	 *
	 */
	template<class OutVector, class InVector>
	OutVector & apply(OutVector &y, const InVector &x) const;

	/** y <- A^T x.
	 *
	 *  Performance will generally be best if A is in cacheOpt order,
	 *  and rowMajor, colMajor orders are generally better than random.
	 *
	 */
	template<class OutVector, class InVector>
	OutVector & applyTranspose(OutVector &, const InVector &) const;

	size_t rowdim() const;

	size_t coldim() const;

	const Field & field() const;

	/*! Returns number of non-zero entries
	 * @warning (some could be zero, for instance after a rebind...
	 */
	size_t size() const;


	void resize( size_t row, size_t col, size_t nbnz =  0)
	{
		rows_ = row ;
		cols_ = col ;
		data_.resize(nbnz);
	}

	template<typename _Tp1, typename _Rw1 >
	struct rebind ;


	template<typename Tp1_, typename _Rw1 = SparseMatrixFormat::TPL>
	struct rebind {
		typedef SparseMatrix<Tp1_, SparseMatrixFormat::TPL> other;
		void operator() (other & Ap, const Self_t& A)
		{
			Hom <typename Self_t::Field, Tp1_> hom( A.field(), Ap.field( ));

			// typedef typename Tp1_::Element otherElt;
			typedef typename other::Rep othervec;
			typedef typename othervec::iterator otheriter;
			otheriter vp_i;
			typedef Rep selfvec;
			typedef typename selfvec::const_iterator selfiter;
			selfiter v_i;

			Ap.resize(A.rowdim(),A.coldim(),A.size());
			// Ap.data_.resize(A.data.size()); !!! this is protected

			for (v_i = A.refDataConst().begin(), vp_i = Ap.refData().begin();
			     v_i != A.refDataConst().end(); ++ v_i, ++ vp_i)
				hom.image (vp_i->elt, v_i->elt);
		}
	};

	template<typename _Tp1, typename _Rw1>
	SparseMatrix (const SparseMatrix<_Tp1, _Rw1> &S, const Field& F) :
		MD_(F), data_(), rows_(0), cols_(0), sort_(unsorted)
	  {
		  typename SparseMatrix<_Tp1,_Rw1>::template rebind<Field,SparseMatrixFormat::TPL>()(*this, S);
	  }



	protected:
	MatrixDomain<Field> MD_; // Contains the field and dense mat ops for applyLeft and applyRight

	struct Triple { Index row; Index col; Element elt;
		Triple(Index& r, Index& c, const Element& e)
		{ init(r, c, e); }
		Triple() {} ;
		void init(Index& r, Index& c, const Element& e)
		{ row = r; col = c; elt = e; }
	};

	// the data
	std::vector<Triple> data_;

	/// The number of rows, columns
	Index rows_, cols_;

	sortPolicy sort_;
	// 0 = unsorted, 1 = cache optimized, 2 = row major, 3 = col major.
	//int sort_;
	public:
	typedef std::vector<Triple> Rep ;
	const std::vector<Triple> & refDataConst() const
	{
		return data_ ;
	}
	std::vector<Triple> & refData()
	{
		return data_ ;
	}



  }; // SparseMatrix
  
  template<class Field>
  struct is_blockbb<SparseMatrix<Field,SparseMatrixFormat::TPL>> {
  	  static const bool value = true;
  };

} // namespace LinBox

#include "sparse-tpl-matrix.inl"

#endif // __LINBOX_matrix_sparsematrix_sparse_tpl_matrix_H

// Local Variables:
// mode: C++
// tab-width: 4
// indent-tabs-mode: nil
// c-basic-offset: 4
// End:
// vim:sts=4:sw=4:ts=4:et:sr:cino=>s,f0,{0,g0,(0,\:0,t0,+0,=s
