File: DisplayTerminal.cc

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 (681 lines) | stat: -rw-r--r-- 17,365 bytes parent folder | download | duplicates (3)
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681

#include "Algorithm.hh"
#include "DisplayTerminal.hh"
#include "properties/Accent.hh"

using namespace cadabra;

DisplayTerminal::DisplayTerminal(const Kernel& k, const Ex& e, bool uuc)
	: DisplayBase(k, e), use_unicode(uuc)
	{
	symmap = {
			{"\\cos", "cos"},
			{"\\sin", "sin"},
			{"\\tan", "tan"},
			{"\\cosh", "cosh"},
			{"\\sinh", "sinh"},
			{"\\tanh", "tanh"},
			{"\\int", "∫" },
			{"\\sum", "∑" }
		};

	greekmap = {
			{"\\alpha",   "α" },
			{"\\beta",    "β" },  // beta seems to be reserved
			{"\\gamma",   "γ" }, // gamma seems to be reserved
			{"\\delta",   "δ" },
			{"\\epsilon", "ε" },
			{"\\zeta",    "ζ" },
			{"\\eta",     "η" },
			{"\\theta",   "θ" },
			{"\\iota",    "ι" },
			{"\\kappa",   "κ" },
			{"\\lambda",  "λ" }, // lambda is reserved
			{"\\mu",      "μ" },
			{"\\nu",      "ν" },
			{"\\xi",      "ξ" },
			{"\\omicron", "ο" },
			{"\\pi",      "π" },
			{"\\rho",     "ρ" },
			{"\\sigma",   "σ" },
			{"\\tau",     "τ" },
			{"\\upsilon", "υ" },
			{"\\phi",     "φ" },
			{"\\chi",     "χ" },
			{"\\psi",     "ψ" },
			{"\\omega",   "ω" },

			{"\\Alpha",   "Α" },
			{"\\Beta",    "Β" },
			{"\\Gamma",   "Γ" },
			{"\\Delta",   "Δ" },
			{"\\Epsilon", "Ε" },
			{"\\Zeta",    "Ζ" },
			{"\\Eta",     "Η" },
			{"\\Theta",   "ϴ" },
			{"\\Iota",    "Ι" },
			{"\\Kappa",   "Κ" },
			{"\\Lambda",  "Λ" },
			{"\\Mu",      "Μ" },
			{"\\Nu",      "Ν" },
			{"\\Xi",      "Ξ" },
			{"\\Omicron", "Ο" },
			{"\\Pi",      "Π" },
			{"\\Rho",     "Ρ" },
			{"\\Sigma",   "Σ" },
			{"\\Tau",     "Τ" },
			{"\\Upsilon", "Υ" },
			{"\\Phi",     "Φ" },
			{"\\Chi",     "Χ" },
			{"\\Psi",     "Ψ" },
			{"\\Omega",   "Ω" },

		};
	}

// Logic: each node should check whether it needs to have brackets printed around
// all of itself. The function below will determine that by inspecting the parent
// node. Nodes should NOT print brackets for children.

bool DisplayTerminal::needs_brackets(Ex::iterator it)
	{
	// FIXME: may need looking at properties
	// FIXME: write as individual parent/current tests
	if(tree.is_head(it)) return false;

	//	Ex::iterator parent_it = tree.parent(it);
	Ex::iterator child_it  = it;
	int child_num = tree.index(it);

	std::string parent=*tree.parent(it)->name;
	std::string child =*it->name;

	if(parent=="\\partial" && child=="\\sum") return true;

	if(parent=="\\frac" && ( child=="\\sum" || child=="\\prod" || (*child_it->multiplier!=1 && child_num>0) )) return true;

	if(parent=="\\pow" && ( !it->is_integer() || child=="\\prod" || child=="\\sum" || child=="\\pow")  ) return true;

	// negative and fractional exponents need brackets.
	if(parent=="\\pow" && (*it->multiplier < 0 || !it->is_integer()) ) return true;

	//	if(parent=="\\pow" && child_num>0 && *child_it->multiplier!=1 ) return true;

	if(parent=="\\prod" && child=="\\sum") return true;

	//	if(it->fl.parent_rel==str_node::p_none && (child=="\\sum" || child=="\\prod") ) return true;

	return false;
	}

//void DisplayTerminal::dispatch(std::ostream& str, Ex::iterator it)
//	{
//
//	// print multiplier and object name
//	if(*it->multiplier!=1)
//		print_multiplier(str, it);
//
//	if(*it->name=="1") {
//		if(*it->multiplier==1 || (*it->multiplier==-1)) // this would print nothing altogether.
//			str << "1";
//		return;
//		}
//
//	bool needs_extra_brackets=false;
//	const Accent *ac=kernel.properties.get<Accent>(it);
//	if(!ac) { // accents should never get additional curly brackets, {\bar}{g} does not print.
//		Ex::sibling_iterator sib=tree.begin(it);
//		while(sib!=tree.end(it)) {
//			if(sib->is_index())
//				needs_extra_brackets=true;
//			++sib;
//			}
//		}
//
//	if(needs_extra_brackets) str << "{"; // to prevent double sup/sub script errors
//	auto rn = symmap.find(*it->name);
//	if(rn!=symmap.end())
//		str << rn->second;
//	else
//		str << *it->name;
//	if(needs_extra_brackets) str << "}";
//
//	print_children(str, it);
//	}

void DisplayTerminal::print_children(std::ostream& str, Ex::iterator it, int skip)
	{
	str_node::bracket_t    previous_bracket_   =str_node::b_invalid;
	str_node::parent_rel_t previous_parent_rel_=str_node::p_invalid;

	int number_of_nonindex_children=0;
	int number_of_index_children=0;
	Ex::sibling_iterator ch=tree.begin(it);
	while(ch!=tree.end(it)) {
		if(ch->is_index()==false) {
			++number_of_nonindex_children;
			if(*ch->name=="\\prod")
				++number_of_nonindex_children;
			}
		else ++number_of_index_children;
		++ch;
		}

	ch=tree.begin(it);
	ch+=skip;
	unsigned int chnum=0;
	while(ch!=tree.end(it)) {
		str_node::bracket_t    current_bracket_   =(*ch).fl.bracket;
		str_node::parent_rel_t current_parent_rel_=(*ch).fl.parent_rel;
		const Accent *is_accent=kernel.properties.get<Accent>(it);

		if(current_bracket_==str_node::b_none) {
			if(previous_bracket_==str_node::b_none && current_parent_rel_==previous_parent_rel_ && current_parent_rel_==str_node::p_none)
				str << ", ";
			}

		if(current_bracket_!=str_node::b_none || previous_bracket_!=current_bracket_ || previous_parent_rel_!=current_parent_rel_) {
			print_parent_rel(str, current_parent_rel_, ch==tree.begin(it));
			if(is_accent==0)
				print_opening_bracket(str, (number_of_nonindex_children>1 /* &&number_of_index_children>0 */ &&
				                            current_parent_rel_!=str_node::p_sub &&
				                            current_parent_rel_!=str_node::p_super ? str_node::b_round:current_bracket_),
				                      current_parent_rel_);
			else str << "{";
			}

		// print this child depending on its name or meaning
		dispatch(str, ch);

		++ch;
		if(ch==tree.end(it) || current_bracket_!=str_node::b_none || current_bracket_!=(*ch).fl.bracket || current_parent_rel_!=(*ch).fl.parent_rel) {
			if(is_accent==0)
				print_closing_bracket(str,  (number_of_nonindex_children>1 /* &&number_of_index_children>0 */ &&
				                             current_parent_rel_!=str_node::p_sub &&
				                             current_parent_rel_!=str_node::p_super ? str_node::b_round:current_bracket_),
				                      current_parent_rel_);
			else str  << "}";
			}
		else str << " ";

		previous_bracket_=current_bracket_;
		previous_parent_rel_=current_parent_rel_;
		++chnum;
		}
	}

void DisplayTerminal::print_multiplier(std::ostream& str, Ex::iterator it, int mult)
	{
	mpz_class denom=it->multiplier->get_den();

	if(denom!=1) {
		if(mult*it->multiplier->get_num()<0) {
			str << " - ";
			mult *= -1;
			}
		str << " " << mult * it->multiplier->get_num() << "/" << it->multiplier->get_den() << " ";
		}
	else if(mult * (*it->multiplier)==-1) {
		str << "-";
		}
	else {
		str << mult * (*it->multiplier);
		}

	/*	bool turned_one=false;
		mpz_class denom=it->multiplier->get_den();

		if(*it->multiplier<0) {
			if(*tree.parent(it)->name=="\\sum") { // sum takes care of minus sign
				if(*it->multiplier!=-1) {
					if(denom!=1) {
						str << "\\frac{" << -(it->multiplier->get_num()) << "}{"
						 << it->multiplier->get_den() << "}";
								}
					else {
						str << -(*it->multiplier);
								}
							}
				else                    turned_one=true;
						}
			else	{
				if(denom!=1) {
					str << "(\\frac{" << it->multiplier->get_num() << "}{"
					 << it->multiplier->get_den() << "})";
							}
				else if(*it->multiplier==-1) {
					str << "-";
				turned_one=true;
							}
				else {
					str << "(" << *it->multiplier << ")";
							}
						}
					}
		else {
			if(denom!=1) {
				str << "\\frac{" << it->multiplier->get_num() << "}{"
				 << it->multiplier->get_den() << "}";
						}
			else
				str << *it->multiplier;
					}

		if(!turned_one && !(*it->name=="1"))
		str << "*"; */
	}

void DisplayTerminal::print_opening_bracket(std::ostream& str, str_node::bracket_t br, str_node::parent_rel_t pr)
	{
	switch(br) {
		case str_node::b_none:
			if(pr==str_node::p_none)     str << "(";
			else                         str << "{";
			break;
		case str_node::b_pointy:
			str << "<";
			break;
		case str_node::b_curly:
			str << "{";
			break;
		case str_node::b_round:
			str << "(";
			break;
		case str_node::b_square:
			str << "[";
			break;
		default :
			return;
		}
	++(bracket_level);
	}

void DisplayTerminal::print_closing_bracket(std::ostream& str, str_node::bracket_t br, str_node::parent_rel_t pr)
	{
	switch(br) {
		case str_node::b_none:
			if(pr==str_node::p_none)     str << ")";
			else                         str << "}";
			break;
		case str_node::b_pointy:
			str << ">";
			break;
		case str_node::b_curly:
			str << "}";
			break;
		case str_node::b_round:
			str << ")";
			break;
		case str_node::b_square:
			str << "]";
			break;
		default :
			return;
		}
	--(bracket_level);
	}

void DisplayTerminal::print_parent_rel(std::ostream& str, str_node::parent_rel_t pr, bool)
	{
	switch(pr) {
		case str_node::p_super:
			str << "^";
			break;
		case str_node::p_sub:
			str << "_";
			break;
		case str_node::p_property:
			str << "$";
			break;
		case str_node::p_exponent:
			str << "**";
			break;
		case str_node::p_none:
			break;
		case str_node::p_components:
			break;
		case str_node::p_invalid:
			break;
		}
	}

void DisplayTerminal::dispatch(std::ostream& str, Ex::iterator it)
	{
	if(*it->name=="\\prod")            print_productlike(str, it, " ");
	else if(*it->name=="\\sum")        print_sumlike(str, it);
	else if(*it->name=="\\frac")       print_fraclike(str, it);
	else if(*it->name=="\\comma")      print_commalike(str, it);
	else if(*it->name=="\\commutator") print_commutator(str, it, true);
	else if(*it->name=="\\anticommutator") print_commutator(str, it, false);
	else if(*it->name=="\\arrow")      print_arrowlike(str, it);
	else if(*it->name=="\\inner")      print_dot(str, it);
	else if(*it->name=="\\pow")        print_powlike(str, it);
	else if(*it->name=="\\wedge")      print_productlike(str, it, " ^ ");
	else if(*it->name=="\\conditional")    print_conditional(str, it);
	else if(*it->name=="\\greater" || *it->name=="\\less")  print_relation(str, it);
	else if(*it->name=="\\int")        print_intlike(str, it);
	else if(*it->name=="\\sum")        print_intlike(str, it);
	else if(*it->name=="\\equals")     print_equalitylike(str, it);
	else if(*it->name=="\\components") print_components(str, it);
	else if(*it->name=="\\ldots")      print_dots(str, it);
	else                               print_other(str, it);
	}

void DisplayTerminal::print_commalike(std::ostream& str, Ex::iterator it)
	{
	Ex::sibling_iterator sib=tree.begin(it);
	bool first=true;
	str << "{";
	while(sib!=tree.end(it)) {
		if(first)
			first=false;
		else
			str << ", ";
		dispatch(str, sib);
		++sib;
		}
	str << "}";
	}

void DisplayTerminal::print_arrowlike(std::ostream& str, Ex::iterator it)
	{
	Ex::sibling_iterator sib=tree.begin(it);
	dispatch(str, sib);
	if(use_unicode)
		str << " → ";
	else
		str << " -> ";
	++sib;
	dispatch(str, sib);
	}

void DisplayTerminal::print_dot(std::ostream& str, Ex::iterator it)
	{
	Ex::sibling_iterator sib=tree.begin(it);
	dispatch(str, sib);
	if(use_unicode)
		str << "·";
	else
		str << ".";
	++sib;
	dispatch(str, sib);
	}

void DisplayTerminal::print_fraclike(std::ostream& str, Ex::iterator it)
	{
	Ex::sibling_iterator num=tree.begin(it), den=num;
	++den;

	if(*it->multiplier!=1)
		print_multiplier(str, it);

	//	if(needs_brackets(num))
	//		str << "(";

	if(num->is_rational()==false || (*it->multiplier)==1)
		dispatch(str, num);

	//	if(needs_brackets(num))
	//		str << ")";

	str << "/";

	//	if(needs_brackets(den))
	//		str << "(";

	dispatch(str, den);

	//	if(needs_brackets(den))
	//		str << ")";
	}

void DisplayTerminal::print_productlike(std::ostream& str, Ex::iterator it, const std::string& inbetween)
	{
	if(needs_brackets(it))
		str << "(";

	if(*it->multiplier!=1) {
		print_multiplier(str, it);
		//		Ex::sibling_iterator st=tree.begin(it);
		}

	// To print \prod{\sum{a}{b}}{\sum{c}{d}} correctly:
	// If there is any sum as child, and if the sum children do not
	// all have the same bracket type (different from b_none or b_no),
	// then print brackets.

	str_node::bracket_t previous_bracket_=str_node::b_invalid;
//	bool beginning_of_group=true;
	Ex::sibling_iterator ch=tree.begin(it);
	while(ch!=tree.end(it)) {
		str_node::bracket_t current_bracket_=(*ch).fl.bracket;
		if(previous_bracket_!=current_bracket_) {
			if(current_bracket_!=str_node::b_none) {
				print_opening_bracket(str, current_bracket_, str_node::p_none);
//				beginning_of_group=true;
				}
			}
		dispatch(str, ch);
		++ch;
		if(ch==tree.end(it)) {
			if(current_bracket_!=str_node::b_none)
				print_closing_bracket(str, current_bracket_, str_node::p_none);
			}

		if(ch!=tree.end(it)) {
			str << inbetween;
			}
		previous_bracket_=current_bracket_;
		}

	if(needs_brackets(it))
		str << ")";
	}

void DisplayTerminal::print_sumlike(std::ostream& str, Ex::iterator it)
	{
	assert(*it->multiplier==1);

	if(needs_brackets(it))
		str << "(";

	Ex::sibling_iterator ch=tree.begin(it);
	while(ch!=tree.end(it)) {
		if(*ch->multiplier>=0 && ch!=tree.begin(it))
			str << " + ";

		dispatch(str, ch);
		++ch;
		}

	if(needs_brackets(it))
		str << ")";
	str << std::flush;
	}

void DisplayTerminal::print_powlike(std::ostream& str, Ex::iterator it)
	{
	if(needs_brackets(it))
		str << "(";

	Ex::sibling_iterator sib=tree.begin(it);
	if(*it->multiplier!=1)
		print_multiplier(str, it);
	dispatch(str, sib);
	//	if(needs_brackets(sib))
	//		str << ")";
	str << "**";
	++sib;
	//	if(needs_brackets(sib))
	//		str << "(";
	dispatch(str, sib);

	if(needs_brackets(it))
		str << ")";
	}

void DisplayTerminal::print_conditional(std::ostream& str, Ex::iterator it)
	{
	auto sib=tree.begin(it);
	dispatch(str, sib);
	str << " with ";
	++sib;
	dispatch(str, sib);
	}

void DisplayTerminal::print_relation(std::ostream& str, Ex::iterator it)
	{
	auto sib=tree.begin(it);
	dispatch(str, sib);
	if(*it->name=="\\greater") str << " > ";
	if(*it->name=="\\less")    str << " < ";
	++sib;
	dispatch(str, sib);
	}

void DisplayTerminal::print_intlike(std::ostream& str, Ex::iterator it)
	{
	if(*it->multiplier!=1)
		print_multiplier(str, it);
	if(!use_unicode || getenv("CADABRA_NO_UNICODE")!=0)
		str << *it->name << "{";
	else
		str << symmap[*it->name] << "(";
	Ex::sibling_iterator sib=tree.begin(it);
	dispatch(str, sib);
	++sib;
	if(tree.is_valid(sib)) {
		str << "}{";
		dispatch(str, sib);
		}
	str << "}";
	}

void DisplayTerminal::print_equalitylike(std::ostream& str, Ex::iterator it)
	{
	Ex::sibling_iterator sib=tree.begin(it);
	dispatch(str, sib);
	str << " = ";
	++sib;
	if(sib==tree.end(it))
		throw ConsistencyException("Found equals node with only one child node.");
	dispatch(str, sib);
	}

void DisplayTerminal::print_commutator(std::ostream& str, Ex::iterator it, bool comm)
	{
	if(comm) str << "[";
	else     str << "{";
	auto sib=tree.begin(it);
	bool first=true;
	while(sib!=tree.end(it)) {
		if(!first) str << ", ";
		else       first=false;
		dispatch(str, sib);
		++sib;
		}
	if(comm) str << "]";
	else     str << "}";
	}

void DisplayTerminal::print_components(std::ostream& str, Ex::iterator it)
	{
	if( ! (use_unicode && getenv("CADABRA_NO_UNICODE")==0) ) {
		print_other(str, it);
		return;
		}

	str << R"(□)";
	auto sib=tree.begin(it);
	auto end=tree.end(it);
	--end;
	if(sib!=end) {
		bool needs_close=false;
		str_node::parent_rel_t prel=str_node::parent_rel_t::p_none;
		while(sib!=end) {
			if(sib->fl.parent_rel!=prel) {
				if(needs_close)
					str << "}";
				needs_close=true;
				prel=sib->fl.parent_rel;
				if(prel==str_node::p_sub)   str << "_{";
				if(prel==str_node::p_super) str << "^{";
				}
			dispatch(str, sib);
			++sib;
			}
		if(needs_close)
			str << "}";
		}
	str << "\n";
	sib=tree.begin(end);
	while(sib!=tree.end(end)) {
		str << "    ";
		dispatch(str, sib);
		str << "\n";
		++sib;
		}
	}

bool DisplayTerminal::children_have_brackets(Ex::iterator ch) const
	{
	Ex::sibling_iterator chlds=tree.begin(ch);
	str_node::bracket_t childbr=chlds->fl.bracket;
	if(childbr==str_node::b_none || childbr==str_node::b_no)
		return false;
	else return true;
	}

void DisplayTerminal::print_dots(std::ostream& str, Ex::iterator )
	{
	str << " ... ";
	}

void DisplayTerminal::print_other(std::ostream& str, Ex::iterator it)
	{
	if(needs_brackets(it))
		str << "(";

	// print multiplier and object name
	if(*it->multiplier!=1)
		print_multiplier(str, it);

	if(*it->name=="1") {
		if(*it->multiplier==1 || (*it->multiplier==-1)) // this would print nothing altogether.
			str << "1";
		if(needs_brackets(it))
			str << ")";
		return;
		}

	bool needs_extra_brackets=false;
	//	const Accent *ac=kernel.properties.get<Accent>(it);
	//	if(!ac) { // accents should never get additional curly brackets, {\bar}{g} does not print.
	//		Ex::sibling_iterator sib=tree.begin(it);
	//		while(sib!=tree.end(it)) {
	//			if(sib->is_index())
	//				needs_extra_brackets=true;
	//			++sib;
	//			}
	//		}

	if(needs_extra_brackets) str << "{"; // to prevent double sup/sub script errors
	std::string sbit=*it->name;
	if(use_unicode && getenv("CADABRA_NO_UNICODE")==0) {
		auto rn1 = symmap.find(sbit);
		if(rn1!=symmap.end())
			sbit = rn1->second;
		auto rn = greekmap.find(sbit);
		if(rn!=greekmap.end())
			sbit = rn->second;
		}
	str << sbit;

	if(needs_extra_brackets) str << "}";

	print_children(str, it);


	if(needs_brackets(it))
		str << ")";
	}