File: Scan.h

package info (click to toggle)
ausaxs 1.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 72,592 kB
  • sloc: cpp: 49,853; ansic: 6,901; python: 730; makefile: 18
file content (44 lines) | stat: -rw-r--r-- 1,283 bytes parent folder | download
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
// SPDX-License-Identifier: LGPL-3.0-or-later
// Author: Kristian Lytje

#pragma once

#include <mini/Minimizer.h>

namespace ausaxs::mini {
	/**
	 * @brief A scanning minimizer. 
	 * 		  This algorithm performs a simple scan of the chi2 landscape, and then uses a local minimizer to find the minimum. 
	 * 		  This should only be used for relatively simple optimization problems. 
	 */
	class Scan : public Minimizer {
		public:
			Scan() = default;

			Scan(double(&func)(std::vector<double>), unsigned int evals = 100);

            Scan(std::function<double(std::vector<double>)> func, unsigned int evals = 100);

            Scan(double(&func)(std::vector<double>), const Parameter& param, unsigned int evals = 100);

            Scan(std::function<double(std::vector<double>)> func, const Parameter& param, unsigned int evals = 100);

            /**
             * @brief Destructor.
             */
            virtual ~Scan() override = default;

            /**
             * @brief Generate a landscape of the function.
             */
            mini::Landscape landscape(unsigned int evals) override;

			void add_parameter(const Parameter& param) override;

		private:
			/**
			 * @brief Perform the minimization.
			 */
			Result minimize_override() override;
	};
}