Zsum.h

Go to the documentation of this file.

 
/*
 *  Copyright (C) 2001-2017 Stefan Weinzierl
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
#ifndef __NESTEDSUMS_ZSUM_H__
#define __NESTEDSUMS_ZSUM_H__
 
#include "ginac/ginac.h"
 
namespace nestedsums {
 
 
  class Zsum : public GiNaC::basic
    {
 
      GINAC_DECLARE_REGISTERED_CLASS(Zsum, GiNaC::basic)
 
        // ctors
    public:
      explicit Zsum(const GiNaC::ex & nc);
      Zsum(const GiNaC::ex & nc, const GiNaC::ex & llc);
 
        // functions overriding virtual functions from bases classes
    public:
      void archive(GiNaC::archive_node &node) const override;
      void read_archive(const GiNaC::archive_node &node, GiNaC::lst &sym_lst) override;
 
      unsigned return_type(void) const override { return GiNaC::return_types::noncommutative; }
 
      void print(const GiNaC::print_context & c, unsigned level = 0) const override;
      unsigned precedence(void) const override {return 60;}
      GiNaC::ex eval() const override;
      GiNaC::ex subs(const GiNaC::exmap & m, unsigned options = 0) const override;
 
    protected:
      GiNaC::ex eval_ncmul(const GiNaC::exvector & v) const override;
      GiNaC::ex derivative(const GiNaC::symbol & s) const override;
      unsigned calchash(void) const override;
 
        // new virtual functions which can be overridden by derived classes
    public :
      virtual GiNaC::ex convert_to_Ssum_exvector(const GiNaC::exvector & Z0, const GiNaC::exvector & Z1) const;
      virtual GiNaC::ex shuffle_exvector(const GiNaC::exvector & Z0, const GiNaC::exvector & Z1, const GiNaC::exvector & Z2) const;
 
      virtual GiNaC::ex set_index(const GiNaC::ex & i) const;
      virtual GiNaC::ex shift_plus_one(void) const;
      virtual GiNaC::ex shift_minus_one(void) const;
      virtual GiNaC::ex adjust_upper_limit_downwards(const GiNaC::ex & i) const;
      virtual GiNaC::ex adjust_upper_limit_upwards(const GiNaC::ex & i) const;
      virtual GiNaC::ex adjust_upper_limit_plus_one(void) const;
      virtual GiNaC::ex index_eq_one(void) const;
 
      virtual GiNaC::ex get_head(int k) const;
      virtual GiNaC::ex get_tail(int k) const;
 
      virtual GiNaC::ex antipode(void) const;
 
      virtual GiNaC::ex expand_members(int level = 0) const;
      virtual GiNaC::ex eval_explicit() const;
 
      virtual GiNaC::ex get_first_letter(void) const;
      virtual GiNaC::ex remove_first_letter(void) const;
      virtual GiNaC::ex remove_first_letter(const GiNaC::ex & nc) const;
      virtual GiNaC::ex prepend_letter(const GiNaC::ex & lc) const;
      virtual GiNaC::ex prepend_letter(const GiNaC::ex & nc, const GiNaC::ex & lc) const;
      virtual GiNaC::ex append_letter(const GiNaC::ex & lc) const;
      virtual GiNaC::ex append_letter_list(const GiNaC::ex & lc) const;
 
    protected:
      virtual GiNaC::ex cast_to_Ssum(void) const;
 
      virtual GiNaC::ex multiply_letter_with_last_letter(const GiNaC::ex & lc) const;
      virtual GiNaC::ex multiply_letter_with_first_letter(const GiNaC::ex & lc) const;
      virtual GiNaC::ex concat_two_sums(const GiNaC::ex & Z1, const GiNaC::ex & Z2) const;
 
      // non-virtual functions
    public :
      GiNaC::ex get_index(void) const;
      GiNaC::ex get_letter_list(void) const;
      unsigned get_depth(void) const;
      GiNaC::ex get_weight(void) const;
 
    protected:
 
 
      // friends :
      friend GiNaC::ex shuffle_Zsum(const GiNaC::ex & Z1, const GiNaC::ex & Z2);
      friend GiNaC::ex convert_Zsum_to_Ssum(const GiNaC::ex & Z1);
      friend GiNaC::ex remove_trivial_Zsum(const GiNaC::ex & expr);
 
        // member variables :
 
    protected:
 
      GiNaC::ex n;
      GiNaC::ex letter_list;
    };
 
GINAC_DECLARE_UNARCHIVER(Zsum);
 
  // inline functions
 
inline GiNaC::ex Zsum::get_index(void) const
  {
    return n;
  }
 
inline GiNaC::ex Zsum::get_letter_list(void) const
  {
    return letter_list;
  }
 
inline unsigned Zsum::get_depth(void) const
  {
    return letter_list.nops();
  }
 
inline GiNaC::ex create_Zsum(const GiNaC::ex & nc, const GiNaC::ex & llc)
  {
    return (new Zsum(nc,llc))->setflag(GiNaC::status_flags::dynallocated);
  }
 
 GiNaC::ex shuffle_Zsum(const GiNaC::ex & Z1, const GiNaC::ex & Z2);
 
 GiNaC::ex convert_Zsum_to_Ssum(const GiNaC::ex & Z1);
 
 GiNaC::ex create_Zsum_from_exvector(const GiNaC::ex & nc, const GiNaC::exvector & v);
 
 GiNaC::ex Zsum_to_Ssum(const GiNaC::ex & expr);
 
 GiNaC::ex shift_upper_limit_plus_one_for_Zsum(const GiNaC::ex & expr);
 
 GiNaC::ex remove_negative_degrees_from_Zsum(const GiNaC::ex & expr);
 
 GiNaC::ex remove_trivial_Zsum(const GiNaC::ex & expr);
 
} // namespace nestedsums
 
#endif // ndef __NESTEDSUMS_ZSUM_H__