/usr/include/openturns/TimeSeries.hxx is in libopenturns-dev 1.9-5.
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 | // -*- C++ -*-
/**
* @brief The class TimeSeries implements values indexed by time
*
* Copyright 2005-2017 Airbus-EDF-IMACS-Phimeca
*
* This library 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.
*
* This library 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 PARTCULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef OPENTURNS_TIMESERIES_HXX
#define OPENTURNS_TIMESERIES_HXX
#include <stdint.h> // for uint64_t
#include <cmath> // for nearbyint
#include "openturns/Point.hxx"
#include "openturns/Description.hxx"
#include "openturns/Indices.hxx"
#include "openturns/PersistentCollection.hxx"
#include "openturns/Collection.hxx"
#include "openturns/Sample.hxx"
#include "openturns/Graph.hxx"
#include "openturns/RegularGrid.hxx"
#include "openturns/FieldImplementation.hxx"
#include "openturns/Field.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class TimeSeries
*/
class OT_API TimeSeries
: public FieldImplementation
{
CLASSNAME;
public:
/**
* Default constructor
*/
TimeSeries();
/** Standard constructor */
TimeSeries(const UnsignedInteger n,
const UnsignedInteger dim);
/** Constructor from a TimeGrid and a dimension */
TimeSeries(const RegularGrid & tg,
const UnsignedInteger dim);
/** Constructor from a TimeGrid and a sample */
TimeSeries(const RegularGrid & tg,
const Sample & sample);
/** Constructor from a Field */
TimeSeries(const Field & field);
#ifndef SWIG
/** Constructor from a collection of Point */
TimeSeries(const Collection<Point> & coll);
#endif
/** Virtual constructor */
TimeSeries * clone() const;
/**
* String converter
* This method shows human readable information on the
* internal state of an TimeSeries. It is used when streaming
* the TimeSeries or for user information.
*/
virtual String __repr__() const;
virtual String __str__(const String & offset = "") const;
Bool operator ==(const TimeSeries & other) const;
/** Append an element to the collection */
TimeSeries & add(const Point & point);
/** Append a sample to the collection */
TimeSeries & add(const Sample & sample);
/** Append another time series to the collection. The time grids must match (one follows the other) */
TimeSeries & add(const TimeSeries & continuer);
/** Method save() stores the object through the StorageManager */
virtual void save(Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
virtual void load(Advocate & adv);
private:
/** The start time of the time series */
Scalar start_;
/** The interval of the underlying regular time grid */
Scalar timeStep_;
/** The number of timestamps of the underlying regular time grid */
UnsignedInteger n_;
}; /* class TimeSeries */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_TIMESERIES_HXX */
|