intRange.h

Go to the documentation of this file.

// ========================================================================= //
// This file is part of MyraMath, copyright (c) 2014-2019 by Ryan A Chilton  //
// and distributed by MyraCore, LLC. See LICENSE.txt for license terms.      //
// ========================================================================= //

#ifndef MYRAMATH_DENSE_INTRANGE_H
#define MYRAMATH_DENSE_INTRANGE_H

#include <myramath/utility/detail/LIBPUBLIC.h>

#include <iosfwd>
#include <utility>
#include <vector>
#ifdef MYRAMATH_ENABLE_CPP11
#include <initializer_list>
#endif


namespace myra {

// Forward declarations.
template<class T> class Array1;
class OutputStream;
class intRange;
class intCRange;

class LIBPUBLIC intRange
  {
  public:

    int* begin;
    int N;

    // Useful typedef.
    typedef std::pair<intRange,intRange> Pair;

    // ------------------------------------ Construction and range semantics.

    intRange();

    intRange(int* in_begin, int in_N);

    intRange(std::vector<int>& v);

    void write(OutputStream& out) const;

    // ------------------------------------ Size queries.

    int size() const;

    int n_words() const; 

    // ------------------------------------ General slicing.

    intCRange add_const() const;
    
    operator intCRange() const;

    intRange window(int n0, int n1) const;

    Array1<intRange> windows(const intCRange& n) const;

    int& operator() (int n) const;
    int& operator[] (int n) const;

    int& at(int n) const;

    // ------------------------------------ Vector-like slicing.

    intRange first(int n) const;

    intRange cut_first(int n) const;

    Pair split_first(int n) const;

    intRange last(int n) const;

    intRange cut_last(int n) const;

    Pair split_last(int n) const;

    std::vector<int> make_vector() const;

    // ------------------------------------ Mutating underlying contents.

    // Functor f should be a have an operator(), that takes an int and returns an int.
    template<class Functor> void transform(const Functor& f) const
      {
      for (int n = 0; n < N; ++n)
        *pointer(n) = f( *pointer(n) );
      }

    void assign(const intCRange& that) const;

    void zero() const;

  private:
  
    // Returns pointer to n'th entry.
    int* pointer(int n) const;

    // Throws if that is not the same size as *this.
    void check_size(const intCRange& that) const;

    // Throws if S is not the same size as *this.
    void check_size(int S) const;
    
  };

class LIBPUBLIC intCRange
  {
  public:

    const int* begin;
    int N;

    // Useful typedef.
    typedef std::pair<intCRange,intCRange> Pair;

    // ------------------------------------ Construction and range semantics.

    intCRange();

    intCRange(const int* in_begin, int in_N);

    intCRange(const std::vector<int>& v);

#ifdef MYRAMATH_ENABLE_CPP11
    intCRange(std::initializer_list<int> l);
#endif

    void write(OutputStream& out) const;

    // ------------------------------------ Size queries.

    int size() const;

    int n_words() const;

    // ------------------------------------ General slicing.

    intRange remove_const() const;

    intCRange window(int n0, int n1) const;

    Array1<intCRange> windows(const intCRange& n) const;

    const int& operator() (int n) const;
    const int& operator[] (int n) const;

    const int& at(int n) const;
 
    // ------------------------------------ Vector-like slicing.

    intCRange first(int n) const;

    intCRange cut_first(int n) const;

    Pair split_first(int n) const;

    intCRange last(int n) const;

    intCRange cut_last(int n) const;

    Pair split_last(int n) const;

    std::vector<int> make_vector() const;

  private:
    
    // Returns pointer to n'th entry.
    const int* pointer(int n) const;
    
  };

LIBPUBLIC Array1<intCRange> add_const(const Array1<intRange>& ranges);

LIBPUBLIC Array1<intRange> remove_const(const Array1<intCRange>& ranges);

LIBPUBLIC std::ostream& operator << (std::ostream& out, const intCRange& r);

std::vector<int> cumsum(const intCRange& input);

} // namespace myra

#endif