ArrayGenerator.h

Go to the documentation of this file.

// BSD 3-Clause License; see https://github.com/scikit-hep/awkward-1.0/blob/main/LICENSE

#ifndef AWKWARD_ARRAYGENERATOR_H_
#define AWKWARD_ARRAYGENERATOR_H_

#include "awkward/Slice.h"
#include "awkward/Content.h"
#include "awkward/virtual/ArrayCache.h"

namespace awkward {

  class ArrayGenerator;
  using ArrayGeneratorPtr = std::shared_ptr<ArrayGenerator>;

  class LIBAWKWARD_EXPORT_SYMBOL ArrayGenerator {
  public:
    ArrayGenerator(const FormPtr& form, int64_t length);

    virtual ~ArrayGenerator();

    const FormPtr
      form() const;

    int64_t
      length() const;

    virtual const ContentPtr
      generate() const = 0;

    const ContentPtr
      generate_and_check();

    virtual void
      caches(std::vector<ArrayCachePtr>& out) const = 0;

    virtual const std::string
      tostring_part(const std::string& indent,
                    const std::string& pre,
                    const std::string& post) const = 0;

    virtual const std::shared_ptr<ArrayGenerator>
      shallow_copy() const = 0;

    virtual const std::shared_ptr<ArrayGenerator>
      with_form(const FormPtr& form) const = 0;

    virtual const std::shared_ptr<ArrayGenerator>
      with_length(int64_t length) const = 0;

    virtual bool
      referentially_equal(const ArrayGeneratorPtr& other) const = 0;

  protected:
    const FormPtr form_;
    FormPtr inferred_form_{nullptr};
    int64_t length_;
  };


  class LIBAWKWARD_EXPORT_SYMBOL SliceGenerator: public ArrayGenerator {
  public:
    SliceGenerator(const FormPtr& form,
                   int64_t length,
                   const ContentPtr& content,
                   const Slice& slice);

    const ContentPtr
      content() const;

    const Slice
      slice() const;

    const ContentPtr
      generate() const override;

    void
      caches(std::vector<ArrayCachePtr>& out) const override;

    const std::string
      tostring_part(const std::string& indent,
                    const std::string& pre,
                    const std::string& post) const override;

    const std::shared_ptr<ArrayGenerator>
      shallow_copy() const override;

    const std::shared_ptr<ArrayGenerator>
      with_form(const FormPtr& form) const override;

    const std::shared_ptr<ArrayGenerator>
      with_length(int64_t length) const override;

    virtual bool
      referentially_equal(const ArrayGeneratorPtr& other) const override;

  protected:
    const ContentPtr content_;
    const Slice slice_;
  };
}

#endif // AWKWARD_ARRAYGENERATOR_H_