File: PreClean.hh

package info (click to toggle)
cadabra2 2.4.3.2-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 78,732 kB
  • sloc: ansic: 133,450; cpp: 92,064; python: 1,530; javascript: 203; sh: 184; xml: 182; objc: 53; makefile: 51
file content (42 lines) | stat: -rw-r--r-- 1,564 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

#pragma once

#include "Algorithm.hh"

/// \ingroup core
///
/// Handle the entire preclean stage, which turns a parsed expression
/// into an expression which satisfies the Cadabra conventions. This
/// does not involve the property system.
///
/// - All numerical multipliers in a product on the product node, no
///   multiplier on a sum node or on the comma node.
///
/// - Any '\\frac' nodes with a purely numerical denominator should be
///   rewritten as a rational multiplier for the numerator node.
///
/// - Any \\sub nodes get converted to \\sum nodes.

namespace cadabra {

	void pre_clean_dispatch(const Kernel& k, Ex&, Ex::iterator& it);
	void pre_clean_dispatch_deep(const Kernel& k, Ex&);

	/// Cleanup for individual node types.  These are not needed during any
	/// later stages of the manipulation of an expression (and are hence
	/// defined here, not in 'Cleanup.hh').

	void cleanup_updown(const Kernel& k, Ex&, Ex::iterator& it);
	void cleanup_rational(const Kernel& k, Ex&, Ex::iterator& it);
	void cleanup_frac(const Kernel& k, Ex&, Ex::iterator& it);
	void cleanup_sqrt(const Kernel& k, Ex&, Ex::iterator& it);
	void cleanup_sub(const Kernel& k, Ex&, Ex::iterator& it);

	/// Convert parser output which indicates an indexbracket to an actual
	/// indexbracket node.
	void cleanup_indexbracket(const Kernel& k, Ex&, Ex::iterator& it);

	/// Replace all occurrances of 'from' with 'to', return result (does not replace in-place).
	std::string replace_all(std::string const& original, std::string const& from, std::string const& to );

	}