Network.hpp

Go to the documentation of this file.

#ifndef CYTNX_NETWORK_H_
#define CYTNX_NETWORK_H_
 
#include "Type.hpp"
#include "cytnx_error.hpp"
#include <initializer_list>
#include <vector>
#include <map>
#include <fstream>
#include "intrusive_ptr_base.hpp"
#include "utils/utils.hpp"
#include "UniTensor.hpp"
#include "contraction_tree.hpp"
 
#ifdef BACKEND_TORCH
#else
 
  #ifdef UNI_GPU
    #ifdef UNI_CUQUANTUM
      #include <cutensornet.h>
    #endif
  #endif
 
namespace cytnx {
  struct __ntwk {
    enum __nttype { Void = -1, Regular = 0, Fermion = 1 };
  };
  class NetworkType_class {
   public:
    enum : int { Void = -1, Regular = 0, Fermion = 1 };
    std::string getname(const int &nwrktype_id);
  };
  extern NetworkType_class NtType;
 
  class Network_base : public intrusive_ptr_base<Network_base> {
    // protected:
   public:
    int nwrktype_id;
    std::string filename;
    std::vector<UniTensor> tensors;
    std::vector<std::string> TOUT_labels;
 
    cytnx_uint64 TOUT_iBondNum;
 
    // bool ordered;
 
    // Contraction order.
    ContractionTree CtTree;
    std::vector<std::string> ORDER_tokens;
    // order line
    std::string order_line = "";
    // einsum path representation of order
    std::vector<std::pair<cytnx_int64, cytnx_int64>> einsum_path;
 
    // labels corr to the tn list.
    std::vector<std::vector<std::string>> label_arr;
    std::vector<cytnx_int64> iBondNums;
 
    // name of tn.
    std::vector<std::string> names;
    std::map<std::string, cytnx_uint64> name2pos;
 
    // maintan tout leg position : (tesnor id, leg idx) for each open leg.
    std::vector<std::pair<int, int>> TOUT_pos;
 
    // pure int version of the contract labels
    std::vector<std::vector<cytnx_int64>> int_modes;
    std::vector<cytnx_int64> int_out_mode;
 
  #ifdef UNI_GPU
    #ifdef UNI_CUQUANTUM
    // // stream
    // cudaStream_t stream;
    // // cutensornet handle
    // cutensornetHandle_t handle;
 
    // network descriptor
    cutensornetNetworkDescriptor_t descNet;
    // optimizer info
    cutensornetContractionOptimizerInfo_t optimizerInfo;
    #endif
  #endif
    friend class FermionNetwork;
    friend class RegularNetwork;
    friend class Network;
    Network_base() : nwrktype_id(NtType.Void){};
 
    bool HasPutAllUniTensor() {
      for (cytnx_uint64 i = 0; i < this->tensors.size(); i++) {
        if (this->tensors[i].uten_type() == UTenType.Void) return false;
      }
      return true;
    }
 
    // void print_network() const;
 
    // void PreConstruct(bool force = true);
 
    // void PutTensor(cytnx_int64 idx, const UniTensor& UniT, bool force = true);
 
    // void PutTensor(const std::string  &name, const UniTensor &UniT, bool force = true);
 
    // UniTensor Launch(const std::string &Tname="");
 
    // std::string GetContractOrder() const;
    virtual void PutUniTensor(const std::string &name, const UniTensor &utensor);
    virtual void PutUniTensor(const cytnx_uint64 &idx, const UniTensor &utensor);
    virtual void PutUniTensors(const std::vector<std::string> &name,
                               const std::vector<UniTensor> &utensors);
 
    virtual void RmUniTensor(const cytnx_uint64 &idx);
    virtual void RmUniTensor(const std::string &name);
    virtual void RmUniTensors(const std::vector<std::string> &name);
 
    virtual void Contract_plan(const std::vector<UniTensor> &utensors, const std::string &Tout,
                               const std::vector<std::string> &alias,
                               const std::string &contract_order);
 
    virtual void Fromfile(const std::string &fname);
    virtual void FromString(const std::vector<std::string> &content);
    virtual void clear();
    virtual std::string getOptimalOrder();
    // virtual UniTensor Launch(const bool &optimal = false, const std::string &contract_order =
    // "");
 
    virtual std::string getOrder();
    virtual void setOrder(const bool &optimal = false, const std::string &contract_order = "");
 
    virtual UniTensor Launch();
 
    virtual void construct(const std::vector<std::string> &alias,
                           const std::vector<std::vector<std::string>> &labels,
                           const std::vector<std::string> &outlabel, const cytnx_int64 &outrk,
                           const std::string &order, const bool optim);
    virtual void PrintNet(std::ostream &os);
    virtual boost::intrusive_ptr<Network_base> clone();
    virtual void Savefile(const std::string &fname);
    virtual ~Network_base(){};
 
  };  // Network_base
 
  class RegularNetwork : public Network_base {
   public:
    RegularNetwork() { this->nwrktype_id = NtType.Regular; };
    void Fromfile(const std::string &fname);
    void FromString(const std::vector<std::string> &contents);
    void PutUniTensor(const std::string &name, const UniTensor &utensor);
    void PutUniTensor(const cytnx_uint64 &idx, const UniTensor &utensor);
    void PutUniTensors(const std::vector<std::string> &name,
                       const std::vector<UniTensor> &utensors);
    // void initialize_CtTree();
    void RmUniTensor(const cytnx_uint64 &idx);
    void RmUniTensor(const std::string &name);
    void RmUniTensors(const std::vector<std::string> &name);
 
    void Contract_plan(const std::vector<UniTensor> &utensors, const std::string &Tout,
                       const std::vector<std::string> &alias = {},
                       const std::string &contract_order = "");
    void clear() {
      this->tensors.clear();
      this->name2pos.clear();
      this->CtTree.clear();
      this->names.clear();
      this->iBondNums.clear();
      this->label_arr.clear();
      this->TOUT_labels.clear();
      this->TOUT_iBondNum = 0;
      this->ORDER_tokens.clear();
    }
    std::string getOptimalOrder();
    // UniTensor Launch(const bool &optimal = false, const std::string &contract_order = "");
 
    std::string getOrder();
    void setOrder(const bool &optimal = false, const std::string &contract_order = "");
    UniTensor Launch();
 
    void construct(const std::vector<std::string> &alias,
                   const std::vector<std::vector<std::string>> &labels,
                   const std::vector<std::string> &outlabel, const cytnx_int64 &outrk,
                   const std::string &order, const bool optim);
    boost::intrusive_ptr<Network_base> clone() {
      RegularNetwork *tmp = new RegularNetwork();
      tmp->name2pos = this->name2pos;
      tmp->CtTree = this->CtTree;
      tmp->names = this->names;
      tmp->iBondNums = this->iBondNums;
      tmp->label_arr = this->label_arr;
      tmp->TOUT_labels = this->TOUT_labels;
      tmp->TOUT_iBondNum = this->TOUT_iBondNum;
      tmp->ORDER_tokens = this->ORDER_tokens;
      boost::intrusive_ptr<Network_base> out(tmp);
      return out;
    }
    void PrintNet(std::ostream &os);
    void Savefile(const std::string &fname);
    ~RegularNetwork(){};
  };
 
  // Under dev!!
  class FermionNetwork : public Network_base {
   protected:
    // [Future] Swap gates.
 
   public:
    FermionNetwork() { this->nwrktype_id = NtType.Fermion; };
    void Fromfile(const std::string &fname){};
    void FromString(const std::vector<std::string> &contents){};
    void RmUniTensor(const cytnx_uint64 &idx){};
    void RmUniTensor(const std::string &name){};
    void RmUniTensors(const std::vector<std::string> &name){};
 
    void PutUniTensor(const std::string &name, const UniTensor &utensor){};
    void PutUniTensor(const cytnx_uint64 &idx, const UniTensor &utensor){};
    void PutUniTensors(const std::vector<std::string> &name,
                       const std::vector<UniTensor> &utensors){};
    void Contract_plan(const std::vector<UniTensor> &utensors, const std::string &Tout,
                       const std::vector<std::string> &alias = {},
                       const std::string &contract_order = ""){};
    void clear() {
      this->name2pos.clear();
      this->CtTree.clear();
      this->names.clear();
      this->iBondNums.clear();
      this->label_arr.clear();
      this->TOUT_labels.clear();
      this->TOUT_iBondNum = 0;
      this->ORDER_tokens.clear();
    }
    UniTensor Launch(const bool &optimal = false, const std::string &contract_order = "") {
      return UniTensor();
    };
    boost::intrusive_ptr<Network_base> clone() {
      FermionNetwork *tmp = new FermionNetwork();
      tmp->name2pos = this->name2pos;
      tmp->CtTree = this->CtTree;
      tmp->names = this->names;
      tmp->iBondNums = this->iBondNums;
      tmp->label_arr = this->label_arr;
      tmp->TOUT_labels = this->TOUT_labels;
      tmp->TOUT_iBondNum = this->TOUT_iBondNum;
      tmp->ORDER_tokens = this->ORDER_tokens;
      boost::intrusive_ptr<Network_base> out(tmp);
      return out;
    }
    void PrintNet(std::ostream &os){};
    void Savefile(const std::string &fname){};
    ~FermionNetwork(){};
  };
 
 
  /* @brief the Network object for easy build tensor network.
 
       The Network is an object that allow one to create a complex network from a pre-defined
     Network file. By putting the Tensors into the Network, the user simply call “Network.Launch()”
     to get the out-come.
  */
  class Network {
   public:
    boost::intrusive_ptr<Network_base> _impl;
    Network() : _impl(new Network_base()){};
    Network(const Network &rhs) { this->_impl = rhs._impl; }
    Network &operator=(const Network &rhs) {
      this->_impl = rhs._impl;
      return *this;
    }
 
    void Fromfile(const std::string &fname, const int &network_type = NtType.Regular) {
      if (network_type == NtType.Regular) {
        boost::intrusive_ptr<Network_base> tmp(new RegularNetwork());
        this->_impl = tmp;
      } else {
        cytnx_error_msg(true, "[Developing] currently only support regular type network.%s", "\n");
      }
      this->_impl->Fromfile(fname);
    }
 
    void FromString(const std::vector<std::string> &contents,
                    const int &network_type = NtType.Regular) {
      if (network_type == NtType.Regular) {
        boost::intrusive_ptr<Network_base> tmp(new RegularNetwork());
        this->_impl = tmp;
      } else {
        cytnx_error_msg(true, "[Developing] currently only support regular type network.%s", "\n");
      }
      this->_impl->FromString(contents);
    }
    // void Savefile(const std::string &fname);
 
    static Network Contract(const std::vector<UniTensor> &tensors, const std::string &Tout,
                            const std::vector<std::string> &alias = {},
                            const std::string &contract_order = "") {
      boost::intrusive_ptr<Network_base> tmp(new RegularNetwork());
      Network out;
      out._impl = tmp;
      out._impl->Contract_plan(tensors, Tout, alias, contract_order);
      return out;
    }
 
    Network(const std::string &fname, const int &network_type = NtType.Regular) {
      this->Fromfile(fname, network_type);
    }
 
    void RmUniTensor(const std::string &name) { this->_impl->RmUniTensor(name); }
    void RmUniTensor(const cytnx_uint64 &idx) { this->_impl->RmUniTensor(idx); }
    void RmUniTensors(const std::vector<std::string> &names) { this->_impl->RmUniTensors(names); }
    void PutUniTensor(const std::string &name, const UniTensor &utensor,
                      const std::vector<std::string> &label_order = {}) {
      if (label_order.size()) {
        auto tmpu = utensor.permute(label_order);
        this->_impl->PutUniTensor(name, tmpu);
      } else
        this->_impl->PutUniTensor(name, utensor);
    }
    void PutUniTensor(const cytnx_uint64 &idx, const UniTensor &utensor,
                      const std::vector<std::string> &label_order = {}) {
      if (label_order.size()) {
        auto tmpu = utensor.permute(label_order);
        this->_impl->PutUniTensor(idx, tmpu);
      } else
        this->_impl->PutUniTensor(idx, utensor);
    }
 
    void PutUniTensors(const std::vector<std::string> &name,
                       const std::vector<UniTensor> &utensors) {
      this->_impl->PutUniTensors(name, utensors);
    }
    std::string getOptimalOrder(const int &network_type = NtType.Regular) {
      if (network_type == NtType.Regular) {
        return this->_impl->getOptimalOrder();
      } else {
        cytnx_error_msg(true, "[Developing] currently only support regular type network.%s", "\n");
      }
    }
 
    std::string getOrder() { return this->_impl->getOrder(); }
 
    void setOrder(const bool &optimal, const std::string &contract_order /*default ""*/) {
      return this->_impl->setOrder(optimal, contract_order);
    }
 
    UniTensor Launch(const int &network_type = NtType.Regular) {
      if (network_type == NtType.Regular) {
        return this->_impl->Launch();
      } else {
        cytnx_error_msg(true, "[Developing] currently only support regular type network.%s", "\n");
      }
    }
 
    void construct(const std::vector<std::string> &alias,
                   const std::vector<std::vector<std::string>> &labels,
                   const std::vector<std::string> &outlabel = std::vector<std::string>(),
                   const cytnx_int64 &outrk = 0, const std::string &order = "",
                   const bool optim = false, const int &network_type = NtType.Regular) {
      if (network_type == NtType.Regular) {
        boost::intrusive_ptr<Network_base> tmp(new RegularNetwork());
        this->_impl = tmp;
      } else {
        cytnx_error_msg(true, "[Developing] currently only support regular type network.%s", "\n");
      }
      this->_impl->construct(alias, labels, outlabel, outrk, order, optim);
    }
 
    void clear() {
      // boost::intrusive_ptr<Network_base> tmp(new Network_base());
      this->_impl->clear();
    }
 
    Network clone() {
      Network out;
      out._impl = this->_impl->clone();
      return out;
    }
    void PrintNet() { this->_impl->PrintNet(std::cout); }
 
    void Savefile(const std::string &fname) { this->_impl->Savefile(fname); }
  };
 
  std::ostream &operator<<(std::ostream &os, const Network &bin);
}  // namespace cytnx
 
#endif  // BACKEND_TORCH
 
#endif  // CYTNX_NETWORK_H_