indexed.h

Go to the documentation of this file.

 
/*
 *  GiNaC Copyright (C) 1999-2026 Johannes Gutenberg University Mainz, Germany
 *
 *  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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef GINAC_INDEXED_H
#define GINAC_INDEXED_H
 
#include "exprseq.h"
#include "wildcard.h"
 
#include <map>
 
namespace GiNaC {
 
class scalar_products;
class symmetry;

class indexed : public exprseq
{
    GINAC_DECLARE_REGISTERED_CLASS(indexed, exprseq)
 
    friend ex simplify_indexed(const ex & e, exvector & free_indices, exvector & dummy_indices, const scalar_products & sp);
    friend ex simplify_indexed_product(const ex & e, exvector & free_indices, exvector & dummy_indices, const scalar_products & sp);
    friend bool reposition_dummy_indices(ex & e, exvector & variant_dummy_indices, exvector & moved_indices);
 
    // other constructors
public:
    indexed(const ex & b);

    indexed(const ex & b, const ex & i1);

    indexed(const ex & b, const ex & i1, const ex & i2);

    indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3);

    indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3, const ex & i4);

    indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2);

    indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3);

    indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3, const ex & i4);

    indexed(const ex & b, const exvector & iv);

    indexed(const ex & b, const symmetry & symm, const exvector & iv);
 
    // internal constructors
    indexed(const symmetry & symm, const exprseq & es);
    indexed(const symmetry & symm, const exvector & v);
    indexed(const symmetry & symm, exvector && v);
 
    // functions overriding virtual functions from base classes
public:
    unsigned precedence() const override {return 55;}
    bool info(unsigned inf) const override;
    ex eval() const override;
    ex real_part() const override;
    ex imag_part() const override;
    exvector get_free_indices() const override;

    void archive(archive_node& n) const override;
    void read_archive(const archive_node& n, lst& syms) override;
protected:
    ex derivative(const symbol & s) const override;
    ex thiscontainer(const exvector & v) const override;
    ex thiscontainer(exvector && v) const override;
    unsigned return_type() const override;
    return_type_t return_type_tinfo() const override { return op(0).return_type_tinfo(); }
    ex expand(unsigned options = 0) const override;
 
    // new virtual functions which can be overridden by derived classes
    // none
    
    // non-virtual functions in this class
public:
    bool all_index_values_are(unsigned inf) const;

    exvector get_indices() const;

    exvector get_dummy_indices() const;

    exvector get_dummy_indices(const indexed & other) const;

    bool has_dummy_index_for(const ex & i) const;

    ex get_symmetry() const {return symtree;}
 
protected:
    void printindices(const print_context & c, unsigned level) const;
    void print_indexed(const print_context & c, const char *openbrace, const char *closebrace, unsigned level) const;
    void do_print(const print_context & c, unsigned level) const;
    void do_print_latex(const print_latex & c, unsigned level) const;
    void do_print_tree(const print_tree & c, unsigned level) const;
    void validate() const;
 
    // member variables
protected:
    ex symtree; 
};
GINAC_DECLARE_UNARCHIVER(indexed);
 
 
class spmapkey {
public:
    spmapkey() : dim(wild()) {}
    spmapkey(const ex & v1, const ex & v2, const ex & dim = wild());
 
    bool operator==(const spmapkey &other) const;
    bool operator<(const spmapkey &other) const;
 
    void debugprint() const;
 
protected:
    ex v1, v2, dim;
};
 
typedef std::map<spmapkey, ex> spmap;

class scalar_products {
public:
    void add(const ex & v1, const ex & v2, const ex & sp);

    void add(const ex & v1, const ex & v2, const ex & dim, const ex & sp);

    void add_vectors(const lst & l, const ex & dim = wild());

    void clear();
 
    bool is_defined(const ex & v1, const ex & v2, const ex & dim) const;
    ex evaluate(const ex & v1, const ex & v2, const ex & dim) const;
    void debugprint() const;
 
protected:
    spmap spm; /*< Map from defined scalar product pairs to their values */
};
 
 
// utility functions

exvector get_all_dummy_indices(const ex & e);

exvector get_all_dummy_indices_safely(const ex & e);

ex rename_dummy_indices_uniquely(exvector & va, const ex & b, bool modify_va = false);

ex rename_dummy_indices_uniquely(const ex & a, const ex & b);

ex rename_dummy_indices_uniquely(const exvector & va, const exvector & vb, const ex & b);

lst rename_dummy_indices_uniquely(const exvector & va, const exvector & vb);

ex expand_dummy_sum(const ex & e, bool subs_idx = false);
 
} // namespace GiNaC
 
#endif // ndef GINAC_INDEXED_H