Constant qopt::HELP

source ·
pub const HELP: &str = "QOPT OPTIMIZATION LIBRARY\n\nVersion 0.17.0\nDeveloped by Joseph Hobbs under the MIT License\n\nSYNTAX\n\n    [binary-name] [--flag]* [--parameter value]*\n\nFLAGS\n\n    --opt-help              Displays this help menu\n    --quiet                 Does not print updates each iteration\n    --no-stop-early         Disables gradient-based convergence criterion\n\nPARAMETERS\n\n    DESCRIPTIONS\n\n        --print-every [int]     Prints updates every `[int]` iterations\n        --paradigm [str]        Optimizes using the given paradigm\n        --criterion [float]     Sets the magnitude for gradient-based convergence criterion (default: 1.0e-5)\n        --maxiter [int]         Sets the maximum number of iterations (default: 100)\n        --maxtemp [float]       Sets the maximum annealing temperature (for `simulated-annealing` only)\n        --stdev [float]         Sets the standard deviation for population mutation (for stochastic methods only)\n\n    DEFAULTS\n\n        --print-every           1\n        --paradigm [str]        steepest-descent\n        --criterion [float]     1.0e-3\n        --maxiter [int]         100\n        --maxtemp [float]       1.0\n        --stdev [float]         1.0\n\nPARADIGMS\n\n    DETERMINISTIC METHODS\n\n        `steepest-descent` (default)\n            Steepest descent using a gradient-based method.  Ensure to set `criterion` appropriately.\n        \n        `newton`\n            Newton\'s method.  Ensure to set `criterion` appropriately.\n\n    STOCHASTIC METHODS\n\n        `genetic`\n            Genetic algorithm.  Ensure to set `maxiter` and `stdev` appropriately.\n\n        `simulated-annealing`\n            Simulated annealing.  Ensure to set `maxiter`, `maxtemp`, and `stdev` appropriately.\n";