sparse_vector.hpp

Go to the documentation of this file.

 
#ifndef SPARSE_VECTOR_HPP_
#define SPARSE_VECTOR_HPP_
 
#include <iostream>
#include <vector>
 
namespace libsnark
{
 
template<typename T> struct sparse_vector;
 
template<typename T>
std::ostream &operator<<(std::ostream &out, const sparse_vector<T> &v);
 
template<typename T>
std::istream &operator>>(std::istream &in, sparse_vector<T> &v);
 
template<typename T> struct sparse_vector {
 
    std::vector<size_t> indices;
    std::vector<T> values;
    size_t domain_size_;
 
    sparse_vector() = default;
    sparse_vector(const sparse_vector<T> &other) = default;
    sparse_vector(sparse_vector<T> &&other) = default;
    sparse_vector(std::vector<T> &&v);
 
    sparse_vector<T> &operator=(const sparse_vector<T> &other) = default;
    sparse_vector<T> &operator=(sparse_vector<T> &&other) = default;
 
    T operator[](const size_t idx) const;
 
    bool operator==(const sparse_vector<T> &other) const;
    bool operator==(const std::vector<T> &other) const;
 
    bool is_valid() const;
    bool empty() const;
 
    // return domain_size_
    size_t domain_size() const;
    // return the number of indices (representing the number of
    // non-zero entries)
    size_t size() const;
    // return the number bits needed to store the sparse vector
    size_t size_in_bits() const;
 
    // return a pair consisting of the accumulated value and the
    // sparse vector of non-accumulated values
    template<typename FieldT>
    std::pair<T, sparse_vector<T>> accumulate(
        const typename std::vector<FieldT>::const_iterator &it_begin,
        const typename std::vector<FieldT>::const_iterator &it_end,
        const size_t offset) const;
 
    friend std::ostream &operator<<<T>(
        std::ostream &out, const sparse_vector<T> &v);
    friend std::istream &operator>><T>(std::istream &in, sparse_vector<T> &v);
};
 
template<typename T>
std::ostream &operator<<(std::ostream &out, const sparse_vector<T> &v);
 
template<typename T>
std::istream &operator>>(std::istream &in, sparse_vector<T> &v);
 
} // namespace libsnark
 
#include <libsnark/common/data_structures/sparse_vector.tcc>
 
#endif // SPARSE_VECTOR_HPP_