CmdArgs subclass for creativity-results script to run models on generated data. More...
#include <creativity/cmdargs/Results.hpp>
Public Member Functions | |
| virtual std::string | usage () const override |
| Overridden to add " FILENAME". | |
| virtual std::string | help () const override |
| Overridden to add info about the input file. | |
| virtual std::string | versionSuffix () const override |
| Overridden to add " -- result analyzer". | |
 Public Member Functions inherited from creativity::cmdargs::CmdArgs | |
| void | parse (int argc, char const *const *argv) |
| Parses options and verifies them. More... | |
| template<typename T , typename A > | |
| std::enable_if< not std::is_unsigned< T >::value, boost::program_options::typed_value< std::vector< T, A > > * >::type | value (std::vector< T, A > &store) |
| Takes a std::vector of values for options that store multiple values. More... | |
| template<typename T , typename A > | |
| std::enable_if< std::is_unsigned< T >::value, boost::program_options::typed_value< std::vector< Validation< T > > > * >::type | value (std::vector< T, A > &store) |
| Takes a std::vector of values for options that store multiple values. More... | |
| virtual std::string | version () const |
| Returns a version string. | |
Public Attributes | |
| struct { | |
| data::TableFormat type = data::TableFormat::Text | |
| The output format type, defaults to text. | |
| bool text = false | |
| Whether –text was explicitly requested. | |
| bool html = false | |
| Whether –html was explicitly requested. | |
| bool latex = false | |
| Whether –latex was explicitly requested. | |
| unsigned int precision = 5 | |
| The number of significant digits in output values. | |
| } | format |
| The requested format data. | |
| struct { | |
| bool summary = false | |
| Summary of number of simulations in each category. | |
| bool write_or_not = false | |
| Conditional analysis of parameter distributions in write vs non-write simulations. | |
| bool write_or_not_corrcov = false | |
| Include correlation/covariance matrix in write_or_not analysis. | |
| bool average = false | |
| Average effects model. | |
| bool marginal = false | |
| Marginal effects model. | |
| bool all = false | |
| All of the above; this does not need to be checked: if specified, all of the above will be set to true except for write_or_not_corrcov, which needs to be specified explicitly. | |
| bool none = false | |
| None of the above; none of the above will be true. | |
| bool initial = false | |
| If true, include initial parameters in the dependent variables (e.g. More... | |
| bool pre = false | |
| If true, include a few pre. More... | |
| bool shortrun = false | |
| If true, do short-run analysis (will raise error if it doesn't exist in the data file) | |
| bool policy_filter = false | |
If true, only show simulations with policy equal to policy | |
| Policy policy | |
| The policy implied by the given –policy value. More... | |
| } | analysis |
| Whether to run various types of analysis. | |
| bool | condensed = false |
| Condensed output mode. More... | |
| std::string | latex_variables = "" |
| Output latex variables instead of sentences for data summary in –latex mode. | |
| bool | no_headings = false |
| Disable analysis section headings. | |
| struct { | |
| std::string filename | |
| Result analysis output; empty means output to stdout. | |
| bool overwrite = false | |
| If true, overwrite the above, otherwise throw exception. | |
| bool no_preamble = false | |
| If true, suppress preamble/postamble (HTML/LaTeX only) | |
| bool list_filtered_write = false | |
| If true, show has-writing simulation source files. | |
| bool list_filtered_nowrite = false | |
| If true, show non-writing simulation source files. | |
| } | output |
| Output files. | |
| std::string | input |
| The input file to load data from. | |
Protected Member Functions | |
| virtual void | addOptions () override |
| Adds data collector command-line options into the option descriptions. | |
| virtual void | postParse (boost::program_options::variables_map &vars) override |
| Overridden to make sure only one of –text/–html/–latex are given. | |
| Protected Member Functions inherited from creativity::cmdargs::CmdArgs | |
| CmdArgs ()=default | |
| Default constructor is protected; use a suitable subclass. | |
Protected Attributes | |
| std::string | policy_str_ = "any" |
| The –policy argument (which is parsed into analysis.policy and .policy_filter) | |
| Protected Attributes inherited from creativity::cmdargs::CmdArgs | |
| std::string | prog_name_ |
| The program name, populated by parse(). More... | |
| boost::program_options::options_description | options_ |
| The options descriptions variable for all options. | |
| boost::program_options::options_description | invisible_ |
| Like options_, but for hidden options that aren't to be displayed in –help output. | |
| boost::program_options::positional_options_description | positional_ |
| Positional options object. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from creativity::cmdargs::CmdArgs | |
| template<typename T > | |
| static std::enable_if< not std::is_unsigned< T >::value and not std::is_same< T, bool >::value, boost::program_options::typed_value< T > *>::type | value (T &store) |
| Creates an option value object without any special validation wrapper class. More... | |
| template<typename T > | |
| static std::enable_if< std::is_unsigned< T >::value and not std::is_same< T, bool >::value, boost::program_options::typed_value< Validation< T > > * >::type | value (T &storage) |
| Creates an option value object around an unsigned primitive type, with automatic value storage and default value. More... | |
| static boost::program_options::typed_value< bool > * | value (bool &store) |
Creates an option value for a boolean value, that is, for an switch without an argument, with default value as given in store. | |
| template<typename V > | |
| static boost::program_options::typed_value< V > * | value (typename V::value_type &store) |
| Creates an option value object with explicit validation wrapper class V. More... | |
| template<typename V , typename A > | |
| static boost::program_options::typed_value< std::vector< V > > * | value (std::vector< typename V::value_type, A > &store) |
| Creates an option value object around a vector of options with validation wrapper class V applied to each element of the vector. More... | |
| template<long minimum, long denom = 1, typename T > | |
| static boost::program_options::typed_value< Min< T, minimum, denom > > * | min (T &store) |
Shortcut for value<Min<T, n, d>>(val) with T last (so that it can be inferred from val) | |
| template<long maximum, long denom = 1, typename T > | |
| static boost::program_options::typed_value< Max< T, maximum, denom > > * | max (T &store) |
Shortcut for value<Max<T, n, d>>(val) with T last (so that it can be inferred from val) | |
| template<long min, long max, long denom = 1, typename T > | |
| static boost::program_options::typed_value< Range< T, min, max, denom > > * | range (T &store) |
Shortcut for value<Range<T, a, b, d>>(val) with T last (so that it can be inferred from val) | |
| template<long lower, long denom = 1, typename T > | |
| static boost::program_options::typed_value< Above< T, lower, denom > > * | above (T &store) |
Shortcut for value<Above<T, a, d>>(val) with T last (so that it can be inferred from val) | |
| template<long upper, long denom = 1, typename T > | |
| static boost::program_options::typed_value< Below< T, upper, denom > > * | below (T &store) |
Shortcut for value<Below<T, b, d>>(val) with T last (so that it can be inferred from val) | |
Detailed Description
CmdArgs subclass for creativity-results script to run models on generated data.
Member Data Documentation
§ condensed
| bool creativity::cmdargs::Results::condensed = false |
Condensed output mode.
For average effects, this produces a single table instead of detailed equation results
§ initial
| bool creativity::cmdargs::Results::initial = false |
If true, include initial parameters in the dependent variables (e.g.
for write-vs-nowrite).
§ policy
| Policy creativity::cmdargs::Results::policy |
The policy implied by the given –policy value.
If none is given, this will be a no-policy option, and policy_str will be set to "any".
§ pre
| bool creativity::cmdargs::Results::pre = false |
If true, include a few pre.
- variables in the write-vs-not analysis.
Inheritance diagram for creativity::cmdargs::Results:
Collaboration diagram for creativity::cmdargs::Results:
The documentation for this class was generated from the following file:
- creativity/cmdargs/Results.hpp
