/usr/include/dolfin/log/Progress.h is in libdolfin-dev 1.4.0+dfsg-4.
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 | // Copyright (C) 2003-2008 Anders Logg and Jim Tilander
//
// This file is part of DOLFIN.
//
// DOLFIN is free software: you can 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 3 of the License, or
// (at your option) any later version.
//
// DOLFIN 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// First added: 2003-03-14
// Last changed: 2010-11-10
#ifndef __PROGRESS_H
#define __PROGRESS_H
#include <string>
namespace dolfin
{
// FIXME: Replace implementation with wrapper for boost::progress_display
// FIXME: See http://www.boost.org/doc/libs/1_42_0/libs/timer/timer.htm
/// This class provides a simple way to create and update progress
/// bars during a computation.
///
/// *Example*
/// A progress bar may be used either in an iteration with a known number
/// of steps:
///
/// .. code-block:: c++
///
/// Progress p("Iterating...", n);
/// for (int i = 0; i < n; i++)
/// {
/// ...
/// p++;
/// }
///
/// or in an iteration with an unknown number of steps:
///
/// .. code-block:: c++
///
/// Progress p("Iterating...");
/// while (t < T)
/// {
/// ...
/// p = t / T;
/// }
class Progress
{
public:
/// Create progress bar with a known number of steps
///
/// *Arguments*
/// title (std::string)
/// The title.
/// n (unsigned int)
/// Number of steps.
Progress(std::string title, unsigned int n);
/// Create progress bar with an unknown number of steps
///
/// *Arguments*
/// title (std::string)
/// The title.
Progress(std::string title);
/// Destructor
~Progress();
/// Set current position
///
/// *Arguments*
/// p (double)
/// The position.
void operator=(double p);
/// Increment progress
void operator++(int);
private:
// Update progress
void update(double p);
// Title of progress bar
std::string _title;
// Number of steps
std::size_t _n;
// Current position
std::size_t i;
// Minimum time increment
double t_step;
// Minimum counter increment
std::size_t c_step;
// Current progress
double _p;
// Time for latest update
double _t;
// Time for last checking the time
double tc;
// Always visible
bool always;
// Finished flag
bool finished;
// Displayed flag
bool displayed;
// Counter for updates
std::size_t counter;
};
}
#endif
|