FullyDistVec.h

Go to the documentation of this file.

/****************************************************************/
/* Parallel Combinatorial BLAS Library (for Graph Computations) */
/* version 1.6 -------------------------------------------------*/
/* date: 6/15/2017 ---------------------------------------------*/
/* authors: Ariful Azad, Aydin Buluc  --------------------------*/
/****************************************************************/
/*
 Copyright (c) 2010-2017, The Regents of the University of California
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */


#ifndef _FULLY_DIST_VEC_H_
#define _FULLY_DIST_VEC_H_

#include <iostream>
#include <fstream>
#include <vector>
#include <utility>
#include <iterator>
#include <random>
#include "CombBLAS.h"
#include "CommGrid.h"
#include "FullyDist.h"
#include "Exception.h"

namespace combblas {

template <class IT, class NT>
class FullyDistSpVec;

template <class IT, class NT, class DER>
class SpParMat;

template <class IT>
class DistEdgeList;

template <class IU, class NU>
class DenseVectorLocalIterator;

// ABAB: As opposed to SpParMat, IT here is used to encode global size and global indices;
// therefore it can not be 32-bits, in general.
template <class IT, class NT>
class FullyDistVec: public FullyDist<IT,NT, typename combblas::disable_if< combblas::is_boolean<NT>::value, NT >::type >
{
public:
    FullyDistVec ( );
    FullyDistVec ( IT globallen, NT initval);
    FullyDistVec ( std::shared_ptr<CommGrid> grid);
    FullyDistVec ( std::shared_ptr<CommGrid> grid, IT globallen, NT initval);
    FullyDistVec ( const FullyDistSpVec<IT, NT> & rhs ); // Sparse -> Dense conversion constructor
        FullyDistVec ( const std::vector<NT> & fillarr, std::shared_ptr<CommGrid> grid ); // initialize a FullyDistVec with a vector from each processor
    

    template <class ITRHS, class NTRHS>
    FullyDistVec ( const FullyDistVec<ITRHS, NTRHS>& rhs ); // type converter constructor

    class ScalarReadSaveHandler
    {
    public:
        NT getNoNum(IT index) { return static_cast<NT>(1); }

        template <typename c, typename t>
        NT read(std::basic_istream<c,t>& is, IT index)
        {
            NT v;
            is >> v;
            return v;
        }
    
        template <typename c, typename t>
        void save(std::basic_ostream<c,t>& os, const NT& v, IT index)
        {
            os << v;
        }
    };

    template <class HANDLER>
    void ParallelWrite(const std::string & filename, bool onebased, HANDLER handler, bool includeindices = true)
    {
            FullyDistSpVec<IT,NT> tmpSpVec = *this; // delegate
            tmpSpVec.ParallelWrite(filename, onebased, handler, includeindices);
    }  
    void ParallelWrite(const std::string & filename, bool onebased, bool includeindices = true) { ParallelWrite(filename, onebased, ScalarReadSaveHandler(), includeindices); };
    

    template <typename _BinaryOperation>
    void ParallelRead (const std::string & filename, bool onebased, _BinaryOperation BinOp)
    {
            FullyDistSpVec<IT,NT> tmpSpVec = *this; // delegate
            tmpSpVec.ParallelRead(filename, onebased, BinOp);
        *this = tmpSpVec;   // sparse -> dense conversion
    }  

    template <class HANDLER>
    std::ifstream& ReadDistribute (std::ifstream& infile, int master, HANDLER handler); 
    std::ifstream& ReadDistribute (std::ifstream& infile, int master) { return ReadDistribute(infile, master, ScalarReadSaveHandler()); }
    
    template <class HANDLER>
    void SaveGathered(std::ofstream& outfile, int master, HANDLER handler, bool printProcSplits = false);
    void SaveGathered(std::ofstream& outfile, int master) { SaveGathered(outfile, master, ScalarReadSaveHandler(), false); }


    template <class ITRHS, class NTRHS>
    FullyDistVec<IT,NT> & operator=(const FullyDistVec< ITRHS,NTRHS > & rhs);   // assignment with type conversion
    FullyDistVec<IT,NT> & operator=(const FullyDistVec<IT,NT> & rhs);   
    FullyDistVec<IT,NT> & operator=(const FullyDistSpVec<IT,NT> & rhs);     
    
    FullyDistVec<IT,NT> &  operator=(NT fixedval) // assign fixed value
    {
#ifdef _OPENMP
#pragma omp parallel for
#endif
        for(IT i=0; i < arr.size(); ++i)
            arr[i] = fixedval;
        return *this;
    }
    FullyDistVec<IT,NT> operator() (const FullyDistVec<IT,IT> & ri) const;  //<! subsref
    
    FullyDistVec<IT,NT> & operator+=(const FullyDistSpVec<IT,NT> & rhs);        
    FullyDistVec<IT,NT> & operator+=(const FullyDistVec<IT,NT> & rhs);
    FullyDistVec<IT,NT> & operator-=(const FullyDistSpVec<IT,NT> & rhs);        
    FullyDistVec<IT,NT> & operator-=(const FullyDistVec<IT,NT> & rhs);
    bool operator==(const FullyDistVec<IT,NT> & rhs) const;

    void SetElement (IT indx, NT numx); // element-wise assignment
    void SetLocalElement(IT index, NT value) {  arr[index] = value; }; // no checks, local index
    NT   GetElement (IT indx) const;    // element-wise fetch
    NT operator[](IT indx) const        // more c++ like API
    {
        return GetElement(indx);
    }

    void Set(const FullyDistSpVec< IT,NT > & rhs);
    template <class NT1, typename _BinaryOperationIdx, typename _BinaryOperationVal>
    void GSet (const FullyDistSpVec<IT,NT1> & spVec, _BinaryOperationIdx __binopIdx, _BinaryOperationVal __binopVal, MPI_Win win);
    template <class NT1, typename _BinaryOperationIdx>
    FullyDistSpVec<IT,NT> GGet (const FullyDistSpVec<IT,NT1> & spVec, _BinaryOperationIdx __binopIdx, NT nullValue);

    void iota(IT globalsize, NT first);
    void RandPerm();    // randomly permute the vector
    FullyDistVec<IT,IT> sort(); // sort and return the permutation

    using FullyDist<IT,NT,typename combblas::disable_if< combblas::is_boolean<NT>::value, NT >::type>::LengthUntil;
    using FullyDist<IT,NT,typename combblas::disable_if< combblas::is_boolean<NT>::value, NT >::type>::TotalLength;
    using FullyDist<IT,NT,typename combblas::disable_if< combblas::is_boolean<NT>::value, NT >::type>::Owner;
    using FullyDist<IT,NT,typename combblas::disable_if< combblas::is_boolean<NT>::value, NT >::type>::MyLocLength;
    IT LocArrSize() const { return arr.size(); }    // = MyLocLength() once arr is resized
    //TODO: we should change this function and return the vector directly
    const NT * GetLocArr() const { return arr.data(); } // = MyLocLength() once arr is resized

    
    template <typename _Predicate>
    FullyDistSpVec<IT,NT> Find(_Predicate pred) const;  

    FullyDistSpVec<IT,NT> Find(NT val) const;   
    
    template <typename _Predicate>
    FullyDistVec<IT,IT> FindInds(_Predicate pred) const;    

    template <typename _Predicate>
    IT Count(_Predicate pred) const;    

    template <typename _UnaryOperation>
    void Apply(_UnaryOperation __unary_op)
    {   
    std::transform(arr.begin(), arr.end(), arr.begin(), __unary_op);
    }
    
    template <typename _BinaryOperation>
    void ApplyInd(_BinaryOperation __binary_op)
    {
        IT offset = LengthUntil();
        #ifdef _OPENMP
        #pragma omp parallel for
        #endif
        for(size_t i=0; i < arr.size(); ++i)
            arr[i] = __binary_op(arr[i], i + offset);
    }

    template <typename _UnaryOperation, typename IRRELEVANT_NT>
    void Apply(_UnaryOperation __unary_op, const FullyDistSpVec<IT,IRRELEVANT_NT>& mask);

    // extended callback versions
    template <typename _BinaryOperation, typename _BinaryPredicate, class NT2>
    void EWiseApply(const FullyDistVec<IT,NT2> & other, _BinaryOperation __binary_op, _BinaryPredicate _do_op, const bool useExtendedBinOp);
    template <typename _BinaryOperation, typename _BinaryPredicate, class NT2>
    void EWiseApply(const FullyDistSpVec<IT,NT2> & other, _BinaryOperation __binary_op, _BinaryPredicate _do_op, bool applyNulls, NT2 nullValue, const bool useExtendedBinOp);

    // plain fallback versions
    template <typename _BinaryOperation, typename _BinaryPredicate, class NT2>
    void EWiseApply(const FullyDistVec<IT,NT2> & other, _BinaryOperation __binary_op, _BinaryPredicate _do_op)
    {
        EWiseApply(other,
                    EWiseExtToPlainAdapter<NT, NT, NT2, _BinaryOperation>(__binary_op),
                    EWiseExtToPlainAdapter<bool, NT, NT2, _BinaryPredicate>(_do_op),
                    true);
    }
    template <typename _BinaryOperation, typename _BinaryPredicate, class NT2>
    void EWiseApply(const FullyDistSpVec<IT,NT2> & other, _BinaryOperation __binary_op, _BinaryPredicate _do_op, bool applyNulls, NT2 nullValue)
    {
        EWiseApply(other,
                    EWiseExtToPlainAdapter<NT, NT, NT2, _BinaryOperation>(__binary_op),
                    EWiseExtToPlainAdapter<bool, NT, NT2, _BinaryPredicate>(_do_op),
                    applyNulls, nullValue, true);
    }


    template <typename T1, typename T2>
    class retTrue {
        public:
        bool operator()(const T1& x, const T2& y)
        {
            return true;
        }
    };

    template <typename _BinaryOperation, class NT2>
    void EWiseApply(const FullyDistVec<IT,NT2> & other, _BinaryOperation __binary_op)
    {
        this->EWiseApply(other, __binary_op, retTrue<NT, NT2>());
    }
    template <typename _BinaryOperation, class NT2>
    void EWiseApply(const FullyDistSpVec<IT,NT2> & other, _BinaryOperation __binary_op, bool applyNulls, NT2 nullValue)
    {
        this->EWiseApply(other, __binary_op, retTrue<NT, NT2>(), applyNulls, nullValue);
    }
    
    void PrintToFile(std::string prefix)
    {
        std::ofstream output;
        commGrid->OpenDebugFile(prefix, output);
    std::copy(arr.begin(), arr.end(), std::ostream_iterator<NT> (output, " "));
        output << std::endl;
        output.close();
    }

    void PrintInfo(std::string vectorname) const;
    void DebugPrint();
    std::shared_ptr<CommGrid> getcommgrid() const { return commGrid; }
    
    std::pair<IT, NT> MinElement() const; // returns <index, value> pair of global minimum
    
    
    template <typename _BinaryOperation>
    NT Reduce(_BinaryOperation __binary_op, NT identity) const; 

    template <typename OUT, typename _BinaryOperation, typename _UnaryOperation>
    OUT Reduce(_BinaryOperation __binary_op, OUT default_val, _UnaryOperation __unary_op) const;

    void SelectCandidates(double nver);
    
    template <typename _BinaryOperation, typename OUT = typename std::result_of<_BinaryOperation&(NT,NT)>::type>
    void EWiseOut(const FullyDistVec<IT,NT> & rhs, _BinaryOperation __binary_op, FullyDistVec<IT,OUT> & result);

    using FullyDist<IT,NT,typename combblas::disable_if< combblas::is_boolean<NT>::value, NT >::type>::glen; 
    using FullyDist<IT,NT,typename combblas::disable_if< combblas::is_boolean<NT>::value, NT >::type>::commGrid; 

private:
    std::vector< NT > arr;

    template <typename _BinaryOperation>    
    void EWise(const FullyDistVec<IT,NT> & rhs,  _BinaryOperation __binary_op);

    template <class IU, class NU>
    friend class DenseParMat;

    template <class IU, class NU, class UDER>
    friend class SpParMat;

    template <class IU, class NU>
    friend class FullyDistVec;

    template <class IU, class NU>
    friend class FullyDistSpVec;
    
    template <class IU, class NU>
    friend class DenseVectorLocalIterator;

    template <typename SR, typename IU, typename NUM, typename NUV, typename UDER> 
    friend FullyDistVec<IU,typename promote_trait<NUM,NUV>::T_promote> 
    SpMV (const SpParMat<IU,NUM,UDER> & A, const FullyDistVec<IU,NUV> & x );

    template <typename IU, typename NU1, typename NU2>
    friend FullyDistSpVec<IU,typename promote_trait<NU1,NU2>::T_promote> 
    EWiseMult (const FullyDistSpVec<IU,NU1> & V, const FullyDistVec<IU,NU2> & W , bool exclude, NU2 zero);

    template <typename IU, typename NU1, typename NU2, typename _BinaryOperation>
    friend FullyDistSpVec<IU,typename promote_trait<NU1,NU2>::T_promote> 
    EWiseApply (const FullyDistSpVec<IU,NU1> & V, const FullyDistVec<IU,NU2> & W , _BinaryOperation _binary_op, typename promote_trait<NU1,NU2>::T_promote zero);

    template <typename RET, typename IU, typename NU1, typename NU2, typename _BinaryOperation, typename _BinaryPredicate>
    friend FullyDistSpVec<IU,RET> 
    EWiseApply (const FullyDistSpVec<IU,NU1> & V, const FullyDistVec<IU,NU2> & W , _BinaryOperation _binary_op, _BinaryPredicate _doOp, bool allowVNulls, NU1 Vzero, const bool useExtendedBinOp);
    
    template <typename RET, typename IU, typename NU1, typename NU2, typename _BinaryOperation, typename _BinaryPredicate>
    friend FullyDistSpVec<IU,RET>
    EWiseApply_threaded (const FullyDistSpVec<IU,NU1> & V, const FullyDistVec<IU,NU2> & W , _BinaryOperation _binary_op, _BinaryPredicate _doOp, bool allowVNulls, NU1 Vzero, const bool useExtendedBinOp);
    
    template <typename IU>
    friend void RenameVertices(DistEdgeList<IU> & DEL);
    
    template <typename IU, typename NU>
    friend FullyDistVec<IU,NU> Concatenate ( std::vector< FullyDistVec<IU,NU> > & vecs);
    
    template <typename IU, typename NU>
    friend void Augment (FullyDistVec<int64_t, int64_t>& mateRow2Col, FullyDistVec<int64_t, int64_t>& mateCol2Row,
                         FullyDistVec<int64_t, int64_t>& parentsRow, FullyDistVec<int64_t, int64_t>& leaves);
    template <class IU, class DER>
    friend SpParMat<IU, bool, DER> PermMat (const FullyDistVec<IU,IU> & ri, const IU ncol);
    
    
    friend void maximumMatching(SpParMat < int64_t, bool, SpDCCols<int64_t,bool> > & A, FullyDistVec<int64_t, int64_t>& mateRow2Col,FullyDistVec<int64_t, int64_t>& mateCol2Row);
};

}

#include "FullyDistVec.cpp"

#endif