/usr/include/deal.II/base/table_handler.h is in libdeal.ii-dev 8.1.0-6ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 | // ---------------------------------------------------------------------
// $Id: table_handler.h 30316 2013-08-15 11:59:44Z bangerth $
//
// Copyright (C) 1999 - 2013 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------
#ifndef __deal2__table_handler_h
#define __deal2__table_handler_h
#include <deal.II/base/config.h>
#include <deal.II/base/exceptions.h>
#include <map>
#include <vector>
#include <string>
#include <fstream>
#include <ostream>
#include <boost/variant.hpp>
#include <boost/serialization/map.hpp>
#include <boost/serialization/string.hpp>
#include <boost/serialization/vector.hpp>
#include <boost/serialization/split_member.hpp>
DEAL_II_NAMESPACE_OPEN
class TableHandler;
namespace internal
{
/**
* A <tt>TableEntry</tt> stores the value of a table entry.
* It can either be of type int, unsigned int, double or std::string.
* In essence, this structure is the same as
* <code>boost::variant@<int,unsigned int,double,std::string@></code>
* but we wrap this object in a structure for which we can write
* a function that can serialize it. This is also why the function
* is not in fact of type boost::any.
*/
struct TableEntry
{
public:
/**
* Default constructor.
*/
TableEntry ();
/**
* Constructor. Initialize this table element with the value <code>t</code>.
*/
template <typename T>
TableEntry (const T &t);
/**
* Return the value stored by this object. The template type
* T must be one of <code>int,unsigned int,double,std::string</code>
* and it must match the data type of the object originally stored
* in this TableEntry object.
*/
template <typename T>
T get () const;
/**
* Return the numeric value of this object if data has been stored in
* it either as an integer, an unsigned integer, or a double.
*
* @return double
**/
double get_numeric_value () const;
/**
* Cache the contained value with the given formatting and return it. The given parameters
* from the column definition are used for the formatting. The value
* is cached as a string internally in cached_value. The cache needs to be invalidated with this routine
* if the formatting of the column changes.
*/
void cache_string(bool scientific, unsigned int precision) const;
/**
* Return the value cached using cache_string(). This is just a wrapper around cached_value.
*/
const std::string &get_cached_string() const;
/**
* Return a TableEntry object that has the same data type
* of the stored value but with a value that is default
* constructed for this data type. This is used to pad
* columns below previously set ones.
*/
TableEntry get_default_constructed_copy() const;
/**
* Write the data of this object to a
* stream for the purpose of
* serialization.
*/
template <class Archive>
void save (Archive &ar, const unsigned int version) const;
/**
* Read the data of this object from a
* stream for the purpose of
* serialization.
*/
template <class Archive>
void load (Archive &ar, const unsigned int version);
BOOST_SERIALIZATION_SPLIT_MEMBER()
private:
/**
* Abbreviation for the data type stored by this object.
*/
typedef boost::variant<int,unsigned int,unsigned long long int,double,std::string> value_type;
/**
* Stored value.
*/
value_type value;
/**
* cache the current value as a string
*/
mutable std::string cached_value;
friend class dealii::TableHandler;
};
}
/**
* The TableHandler stores TableEntries of arbitrary value
* type and writes the table as text or in tex format to an output
* stream. The value type actually may vary from column to column and
* from row to row.
*
* <h3>Usage</h3>
*
* The most important function is the templatized function
* <code>add_value(const std::string &key, const T value)</code> that adds a
* column with the name <tt>key</tt> to the table if this column does not yet
* exist and adds the given value of type <tt>T</tt> (which must be one of
* <tt>int</tt>, <tt>unsigned int</tt>, <tt>double</tt>, <tt>std::string</tt>)
* to this column. After the table is complete there are different
* possibilities of output, e.g., into a latex file with write_tex() or as text
* with write_text().
*
* Two (or more) columns may be merged into a "supercolumn" by twice
* (or multiple) calling add_column_to_supercolumn(), see
* there. Additionally there is a function to set for each column the
* precision of the output of numbers, and there are several functions
* to prescribe the format and the captions the columns are written
* with in tex mode.
*
* A detailed explanation of this class is also given in the step-13 tutorial
* program.
*
*
* <h3>Example</h3>
*
* This is a simple example demonstrating the usage of this class. The
* first column includes the numbers <tt>i=1..n</tt>, the second
* $1^2$...$n^2$, the third $sqrt(1)...sqrt(n)$, where the second and
* third columns are merged into one supercolumn with the superkey
* <tt>squares and roots</tt>. Additionally the first column is aligned to
* the right (the default was <tt>centered</tt>) and the precision of the
* square roots are set to be 6 (instead of 4 as default).
*
* @code
* TableHandler table;
*
* for (unsigned int i=1; i<=n; ++i)
* {
* table.add_value("numbers", i);
* table.add_value("squares", i*i);
* table.add_value("square roots", sqrt(i));
* }
* // merge the second and third column
* table.add_column_to_supercolumn("squares", "squares and roots");
* table.add_column_to_supercolumn("square roots", "squares and roots");
*
* // additional settings
* table.set_tex_format("numbers", "r");
* table.set_precision("square roots", 6);
*
* // output
* std::ofstream out_file("number_table.tex");
* table.write_tex(out_file);
* out_file.close();
* @endcode
*
*
* <h3>Dealing with sparse data: auto-fill mode</h3>
*
* When generating output, TableHandler expects that all columns have the exact
* same number of elements in it so that the result is in fact a table. This
* assumes that in each of the iterations (time steps, nonlinear iterations, etc)
* you fill every single column. On the other hand, this may not always be what
* you want to do. For example, it could be that the function that computes the
* nonlinear residual is only called every few time steps; or, a function computing
* statistics of the mesh is only called whenever the mesh is in fact refined.
* In these cases, the add_value() function will be called less often for some
* columns and the column would therefore have fewer elements; furthermore, these
* elements would not be aligned with the rows that contain the other data elements
* that were produced during this iteration.
* An entirely different scenario is that the table is filled and at a later time
* we use the data in there to compute the elements of other rows; the ConvergenceTable
* class does something like this.
*
* To support both scenarios, the TableHandler class has a property called
* <i>auto-fill mode</i>. By default, auto-fill mode is off, but it can be
* enabled by calling set_auto_fill_mode(). If auto-fill mode is enabled
* we use the following algorithm:
* - When calling <code>add_value(key, value)</code>, we count the number of elements
* in the column corresponding to <code>key</code>. Let's call this number $m$.
* - We also determine the maximal number of elements in the other columns; call
* it $n$.
* - If $m < n-1$ then we add $n-m-1$ copies of the object <code>T()</code>
* to this column. Here, <code>T</code> is the data type of the given <code>value</code>.
* For example, if <code>T</code> is a numeric type, then <code>T()</code> is
* the number zero; if <code>T</code> is <code>std::string</code>, then
* <code>T()</code> is the empty string <code>""</code>.
* - Add the given value to this column.
*
* Padding the column with default elements makes sure that after the addition the
* column has as many entries as the longest other column. In other words, if
* we have skipped previous invokations of add_value() for a given key, then the
* padding will enter default values into this column.
*
* The algorithm as described will fail if you try to skip adding values for a key
* if adding an element for this key is the first thing you want to do for a given
* iteration or time step, since we would then pad to the length of the longest
* column of the <i>previous</i> iteration or time step. You may have to re-order
* adding to this column to a different spot in your program, after adding to
* a column that will always be added to; or, you may want to start every iteration
* by adding the number of the iteration to the table, for example in column 1.
*
* In the case above, we have always padded columns <b>above</b> the element that
* is being added to a column. However, there is also a case where we have to pad
* <b>below</b>. Namely, if a previous row has been completely filled using
* TableHandler::add_value(), subsequent rows have been filled partially, and we
* then ask for output via write_text() or write_tex(). In that case, the last
* few rows that have been filled only partially need to be padded below the last
* element that has been added to them. As before, we do that by using default
* constructed objects of the same type as the last element of that column.
*
* @ingroup textoutput
* @author Ralf Hartmann, 1999; Wolfgang Bangerth, 2011
*/
class TableHandler
{
public:
/**
* Set of options how a table should be formatted when output with
* the write_text() function. The following possibilities exist:
*
* - <code>table_with_headers</code>: The table is formatted in such a way
* that the contents are aligned under the key of each column, i.e. the
* key sits atop each column. This is suitable for tables with few columns
* where the entire table can be displayed on the screen. Output looks
* like this:
* @code
* key1 key2 key3
* 0 0 ""
* 1 0 ""
* 2 13 a
* 1 0 ""
* @endcode
* - <code>table_with_separate_column_description</code>: This is a better
* format when there are many columns and the table as a whole can not
* be displayed on the screen. Here, the column keys are first listed
* one-by-one on lines of their own, and are numbered for better readability.
* In addition, each of these description lines are prefixed by '#' to mark
* these lines as comments for programs that want to read the following
* table as data and should ignore these descriptive lines. GNUPLOT is
* one such program that will automatically ignore lines so prefixed.
* Output with this option looks like this:
* @code
* # 1: key1
* # 2: key2
* # 3: key3
* 0 0 ""
* 1 0 ""
* 2 13 a
* 1 0 ""
* @endcode
* - <code>simple_table_with_separate_column_description</code>: This format
* is very similar to <code>table_with_separate_column_description</code>,
* but it skips aligning the columns with additional white space. This
* increases the performance o fwrite_text() for large tables. Example output:
* @code
* # 1: key1
* # 2: key2
* # 3: key3
* 0 0 ""
* 1 0 ""
* 2 13 a
* 1 0 ""
* @endcode
* - <code>org_mode_table</code>: Outputs to org-mode (http://orgmode.org/) table
* format. It is easy to convert org-mode tables to HTML/LaTeX/csv.
* Example output:
* @code
* | key1 | key2 | key3 |
* | 0 | 0 | "" |
* | 1 | 0 | "" |
* | 2 | 13 | a |
* | 1 | 0 | "" |
* @endcode
*/
enum TextOutputFormat
{
table_with_headers,
table_with_separate_column_description,
simple_table_with_separate_column_description,
org_mode_table
};
/**
* Constructor.
*/
TableHandler ();
/**
* Adds a column (if not yet existent)
* with the key <tt>key</tt> and adds the
* value of type <tt>T</tt> to the
* column. Values of type <tt>T</tt> must
* be convertible to one of <code>int,
* unsigned int, double,
* std::string</code> or a compiler error
* will result.
*/
template <typename T>
void add_value (const std::string &key,
const T value);
/**
* Switch auto-fill mode on or off. See the general documentation
* of this class for a description of what auto-fill mode does.
*/
void set_auto_fill_mode (const bool state);
/**
* Creates a supercolumn (if not
* yet existent) and includes
* column to it. The keys of the
* column and the supercolumn are
* <tt>key</tt> and <tt>superkey</tt>,
* respectively. To merge two
* columns <tt>c1</tt> and <tt>c2</tt> to a
* supercolumn <tt>sc</tt> hence call
* <tt>add_column_to_supercolumn(c1,sc)</tt>
* and
* <tt>add_column_to_supercolumn(c2,sc)</tt>.
*
* Concerning the order of the
* columns, the supercolumn
* replaces the first column that
* is added to the supercolumn.
* Within the supercolumn the
* order of output follows the
* order the columns are added to
* the supercolumn.
*/
void add_column_to_supercolumn (const std::string &key,
const std::string &superkey);
/**
* Change the order of columns and
* supercolumns in the table.
*
* <tt>new_order</tt> includes the
* keys and superkeys of the
* columns and supercolumns in
* the order the user like to.
* If a superkey is included the
* keys of the subcolumns need
* not to be additionally
* mentioned in this vector. The
* order of subcolumns within a
* supercolumn is not changeable
* and keeps the order in which
* the columns are added to the
* supercolumn.
*
* This function may also be used
* to break big tables with too
* many columns into smaller
* ones. Call this function with
* the first e.g. five columns
* and then <tt>write_*</tt>.
* Afterwards call this function
* with the next e.g. five
* columns and again <tt>write_*</tt>,
* and so on.
*/
void set_column_order (const std::vector<std::string> &new_order);
/**
* Sets the <tt>precision</tt>
* e.g. double or float variables
* are written
* with. <tt>precision</tt> is the
* same as in calling
* <tt>out<<setprecision(precision)</tt>.
*/
void set_precision (const std::string &key,
const unsigned int precision);
/**
* Sets the
* <tt>scientific_flag</tt>. True
* means scientific, false means
* fixed point notation.
*/
void set_scientific (const std::string &key,
const bool scientific);
/**
* Sets the caption of the column
* <tt>key</tt> for tex output. You
* may want to chose this
* different from <tt>key</tt>, if it
* contains formulas or similar
* constructs.
*/
void set_tex_caption (const std::string &key,
const std::string &tex_caption);
/**
* Sets the tex caption of the entire
* <tt>table</tt> for tex output.
*/
void set_tex_table_caption (const std::string &table_caption);
/**
* Sets the label of this
* <tt>table</tt> for tex output.
*/
void set_tex_table_label (const std::string &table_label);
/**
* Sets the caption the the
* supercolumn <tt>superkey</tt> for
* tex output. You may want to
* chose this different from
* <tt>superkey</tt>, if it contains
* formulas or similar
* constructs.
*/
void set_tex_supercaption (const std::string &superkey,
const std::string &tex_supercaption);
/**
* Sets the tex output format of
* a column, e.g. <tt>c</tt>, <tt>r</tt>,
* <tt>l</tt>, or <tt>p{3cm}</tt>. The
* default is <tt>c</tt>. Also if this
* function is not called for a
* column, the default is preset
* to be <tt>c</tt>.
*/
void set_tex_format (const std::string &key,
const std::string &format="c");
/**
* Write table as formatted text to the
* given stream. The text is formatted in
* such as way that it represents data as
* formatted columns of text. To avoid
* problems when reading these tables
* automatically, for example for
* postprocessing, if an entry in a cell
* of this table is empty (i.e. it has
* been created by calling the
* add_value() function with an empty
* string), then the entry of the table
* is printed as <code>""</code>.
*
* The second argument indicates how
* column keys are to be displayed. See
* the description of TextOutputFormat
* for more information
*/
void write_text (std::ostream &out,
const TextOutputFormat format = table_with_headers) const;
/**
* Write table as a tex file. If
* with_header is set to false
* (it is true by default), then
* no "\documentclass{...}",
* "\begin{document}" and
* "\end{document}" are used. In
* this way the file can be
* included into an existing tex
* file using a command like
* "\input{table_file}".
*/
void write_tex (std::ostream &file, const bool with_header=true) const;
/**
* Read or write the data of this
* object to or from a stream for
* the purpose of serialization.
*/
template <class Archive>
void serialize(Archive &ar, const unsigned int version);
/** @addtogroup Exceptions
* @{ */
/**
* Exception
*/
DeclException1 (ExcColumnNotExistent,
std::string,
<< "Column <" << arg1 << "> does not exist.");
/**
* Exception
*/
DeclException1 (ExcSuperColumnNotExistent,
std::string,
<< "Supercolumn <" << arg1 << "> does not exist.");
/**
* Exception
*/
DeclException1 (ExcColumnOrSuperColumnNotExistent,
std::string,
<< "Column or supercolumn <" << arg1 << "> does not exist.");
/**
* Exception
*/
DeclException4 (ExcWrongNumberOfDataEntries,
std::string, int, std::string, int,
<< "Column <" << arg1 << "> has got " << arg2
<< " rows, but Column <" << arg3 << "> has got " << arg4 << ".");
/**
* Exception
*/
DeclException1 (ExcUndefinedTexFormat,
std::string,
<< "<" << arg1 << "> is not a tex column format. Use l,c,r.");
//@}
protected:
/**
* Structure encapsulating all the data
* that is needed to describe one column
* of a table.
*/
struct Column
{
/**
* Constructor needed by STL maps.
*/
Column ();
/**
* Constructor.
*/
Column (const std::string &tex_caption);
/**
* Pad this column with default constructed elements to the
* number of rows given by the argument.
*/
void pad_column_below (const unsigned int length);
/**
* Read or write the data of this
* object to or from a stream for
* the purpose of serialization.
*/
template <class Archive>
void save(Archive &ar, const unsigned int version) const;
template<class Archive>
void load(Archive &ar, const unsigned int version);
BOOST_SERIALIZATION_SPLIT_MEMBER()
/**
* Invalidates the string cache of all the entries and recomputes
* the maximum length max_length.
*/
void invalidate_cache();
/**
* List of entries within
* this column. Values are
* always immediately
* converted to strings to
* provide a uniform method
* of lookup.
*/
std::vector<internal::TableEntry> entries;
/**
* The caption of the column
* in tex output. By
* default, this is the key
* string that is given to
* the <tt>TableHandler</tt> by
* <tt>TableHandler::add_value(...)</tt>. This
* may be changed by calling
* <tt>TableHandler::set_tex_caption(...)</tt>.
*/
std::string tex_caption;
/**
* The column format in tex
* output. By default, this
* is <tt>"c"</tt>, meaning
* `centered'. This may be
* changed by calling
* <tt>TableHandler::set_tex_format(...)</tt>
* with <tt>"c", "r", "l"</tt> for
* centered, right or left.
*/
std::string tex_format;
/**
* Double or float entries
* are written with this
* precision (set by the
* user). The default is 4.
*/
unsigned int precision;
/**
* <tt>scientific</tt>=false means
* fixed point notation.
*/
bool scientific;
/**
* Flag that may be used by
* derived classes for
* arbitrary purposes.
*
* In particular, the
* ConvergenceTable class uses the
* flag to denote columns for which
* convergence information has
* already been computed, or should
* not be computed at all.
*/
unsigned int flag;
/**
* This entry caches the maximum length in characters for all entries in this table.
*/
unsigned int max_length;
};
/**
* Help function that gives a
* vector of the keys of all
* columns that are mentioned in
* <tt>column_order</tt>, where each
* supercolumn key is replaced by
* its subcolumn keys.
*
* This function implicitly
* checks the consistency of the
* data. The result is returned
* in <tt>sel_columns</tt>.
*/
void get_selected_columns (std::vector<std::string> &sel_columns) const;
/**
* Builtin function, that gives
* the number of rows in the
* table and that checks if the
* number of rows is equal in
* every column. This function is
* e.g. called before writing
* output.
*/
unsigned int n_rows() const;
/**
* Stores the column and
* supercolumn keys in the order
* desired by the user. By
* default this is the order of
* adding the columns. This order
* may be changed by
* <tt>set_column_order(...)</tt>.
*/
std::vector<std::string> column_order;
/**
* Maps the column keys to the
* columns (not supercolumns).
*
* The field is declared mutable so
* that the write_text() and write_tex()
* functions can be const, even though they
* may pad columns below if auto_fill_mode
* is on.
*/
mutable std::map<std::string,Column> columns;
/**
* Maps each supercolumn key to
* the the keys of its subcolumns
* in the right order. It is
* allowed that a supercolumn has
* got the same key as a column.
*
* Note that we do not use a <tt>multimap</tt>
* here since the order of column
* keys for each supercolumn key is
* relevant.
*/
std::map<std::string, std::vector<std::string> > supercolumns;
/**
* Maps the supercolumn keys to
* the captions of the
* supercolumns that are used in
* tex output.
*
* By default these are just the
* supercolumn keys but they may
* be changed by
* <tt>set_tex_supercaptions(...)</tt>.
*/
std::map<std::string, std::string> tex_supercaptions;
/**
* The caption of the table itself.
*/
std::string tex_table_caption;
/**
* The label of the table.
*/
std::string tex_table_label;
/**
* Flag indicating whether auto-fill mode should be used.
*/
bool auto_fill_mode;
};
namespace internal
{
template <typename T>
TableEntry::TableEntry (const T &t)
:
value (t)
{}
template <typename T>
T TableEntry::get () const
{
// we don't quite know the data type in 'value', but
// it must be one of the ones in the type list of the
// boost::variant. so if T is not in the list, or if
// the data stored in the TableEntry is not of type
// T, then we will get an exception that we can
// catch and produce an error message
try
{
return boost::get<T>(value);
}
catch (...)
{
Assert(false, ExcMessage ("This TableEntry object does not store a datum of type T"));
throw;
}
}
template <class Archive>
void TableEntry::save (Archive &ar,
const unsigned int) const
{
// write first an identifier for the kind
// of data stored and then the actual
// data, in its correct data type
if (const int *p = boost::get<int>(&value))
{
char c = 'i';
ar &c & *p;
}
else if (const unsigned int *p = boost::get<unsigned int>(&value))
{
char c = 'u';
ar &c & *p;
}
else if (const double *p = boost::get<double>(&value))
{
char c = 'd';
ar &c & *p;
}
else if (const std::string *p = boost::get<std::string>(&value))
{
char c = 's';
ar &c & *p;
}
else
Assert (false, ExcInternalError());
}
template <class Archive>
void TableEntry::load (Archive &ar,
const unsigned int)
{
// following what we do in the save()
// function, first read in the data type
// as a one-character id, and then read
// the data
char c;
ar &c;
switch (c)
{
case 'i':
{
int val;
ar &val;
value = val;
break;
}
case 'u':
{
unsigned int val;
ar &val;
value = val;
break;
}
case 'd':
{
double val;
ar &val;
value = val;
break;
}
case 's':
{
std::string val;
ar &val;
value = val;
break;
}
default:
Assert (false, ExcInternalError());
}
}
}
template <typename T>
void TableHandler::add_value (const std::string &key,
const T value)
{
// see if the column already exists
if (columns.find(key) == columns.end())
{
std::pair<std::string, Column> new_column(key, Column(key));
columns.insert(new_column);
column_order.push_back(key);
}
if (auto_fill_mode == true)
{
// follow the algorithm given in the introduction to this class
// of padding columns as necessary
unsigned int n = 0;
for (std::map< std::string, Column >::iterator p = columns.begin(); p != columns.end(); ++p)
n = (n >= p->second.entries.size() ? n : p->second.entries.size());
while (columns[key].entries.size()+1 < n)
{
columns[key].entries.push_back (internal::TableEntry(T()));
internal::TableEntry &entry = columns[key].entries.back();
entry.cache_string(columns[key].scientific, columns[key].precision);
columns[key].max_length = std::max(columns[key].max_length, static_cast<unsigned int>(entry.get_cached_string().length()));
}
}
// now push the value given to this function
columns[key].entries.push_back (internal::TableEntry(value));
internal::TableEntry &entry = columns[key].entries.back();
entry.cache_string(columns[key].scientific, columns[key].precision);
columns[key].max_length = std::max(columns[key].max_length, static_cast<unsigned int>(entry.get_cached_string().length()));
}
template <class Archive>
void
TableHandler::Column::save(Archive &ar, const unsigned int version) const
{
ar &entries &tex_caption
& tex_format &precision
& scientific
& flag
& max_length;
}
template<class Archive>
void
TableHandler::Column::load(Archive &ar, const unsigned int version)
{
ar &entries &tex_caption
& tex_format &precision
& scientific
& flag
& max_length;
invalidate_cache();
}
template <class Archive>
void
TableHandler::serialize(Archive &ar,
const unsigned int)
{
ar &column_order &columns
& supercolumns &tex_supercaptions
& tex_table_caption
& tex_table_label
& auto_fill_mode;
}
DEAL_II_NAMESPACE_CLOSE
#endif
|