parPE C++ API¶
parPE C++ library functions
Class Hierarchy¶
-
- Namespace parpe
- Struct JobData
- Class AmiciSimulationRunner
- Class AmiciSummedGradientFunction
- Class AnalyticalParameterHdf5Reader
- Class AnalyticalParameterProvider
- Class AnalyticalParameterProviderDefault
- Class CostFunction
- Class CpuTimer
- Class GradientFunction
- Class HDF5Exception
- Class HierarchicalOptimizationProblemWrapper
- Class HierarchicalOptimizationReporter
- Class HierarchicalOptimizationWrapper
- Template Class InverseUniqueLock
- Class LearningRateUpdater
- Class LinearModel
- Class LinearModelMSE
- Class LoadBalancerWorker
- Class LocalOptimizationIpoptTNLP
- Class Logger
- Class MeanSquaredError
- Template Class MinibatchOptimizationProblem
- Template Class MinibatchOptimizer
- Template Class Model
- Class MultiConditionDataProvider
- Class MultiConditionDataProviderDefault
- Class MultiConditionDataProviderHDF5
- Class MultiConditionProblem
- Class MultiConditionProblemMultiStartOptimizationProblem
- Class MultiStartOptimization
- Class MultiStartOptimizationProblem
- Class OptimizationApplication
- Class OptimizationOptions
- Class OptimizationProblem
- Class OptimizationProblemImpl
- Class OptimizationReporter
- Class OptimizationResultWriter
- Class Optimizer
- Class OptimizerCeres
- Class OptimizerDlibLineSearch
- Class OptimizerFides
- Class OptimizerFsqp
- Class OptimizerIpOpt
- Class OptimizerToms611TrustRegionSumsl
- Class ParameterUpdater
- Class ParameterUpdaterAdam
- Class ParameterUpdaterAdamClassic
- Class ParameterUpdaterMomentum
- Class ParameterUpdaterRmsProp
- Class ParameterUpdaterVanilla
- Class ParPEException
- Class SimulationResultWriter
- Class StandaloneSimulator
- Template Class SummedGradientFunction
- Template Class SummedGradientFunctionGradientFunctionAdapter
- Class WallTimer
- Enum ErrorModel
- Enum FunctionEvaluationStatus
- Enum interceptType
- Enum learningRateInterp
- Enum loglevel
- Enum minibatchExitStatus
- Enum optimizerName
- Namespace parpe
File Hierarchy¶
-
- Directory include
- Directory parpeamici
- Directory parpecommon
- File costFunction.h
- File functions.h
- File hdf5Misc.h
- File logging.h
- File misc.h
- File model.h
- File parpeException.h
- Directory parpeloadbalancer
- File loadBalancerMaster.h
- File loadBalancerWorker.h
- Directory parpeoptimization
- File localOptimizationCeres.h
- File localOptimizationDlib.h
- File localOptimizationFides.h
- File localOptimizationFsqp.h
- File localOptimizationIpopt.h
- File localOptimizationIpoptTNLP.h
- File localOptimizationToms611.h
- File minibatchOptimization.h
- File multiStartOptimization.h
- File optimizationOptions.h
- File optimizationProblem.h
- File optimizationResultWriter.h
- File optimizer.h
- Directory include
Full API¶
Namespaces¶
Classes and Structs¶
- Class AmiciSimulationRunner
- Nested Relationships
- Class Documentation
- Class AmiciSummedGradientFunction
- Inheritance Relationships
- Class Documentation
parpe::AmiciSummedGradientFunctionWorkPackageResultPackageResultMapAmiciSummedGradientFunction()~AmiciSummedGradientFunction()evaluate()evaluate()numParameters()getParameterIds()getModelOutputsAndSigmas()getAllMeasurements()messageHandler()getParameterScaling()sendStatesAmiciSummedGradientFunction()runSimulations()aggregateLikelihood()addSimulationGradientToObjectiveFunctionGradient()setSensitivityOptions()
- Class HierarchicalOptimizationProblemWrapper
- Inheritance Relationships
- Class Documentation
parpe::HierarchicalOptimizationProblemWrapperHierarchicalOptimizationProblemWrapper()HierarchicalOptimizationProblemWrapper()HierarchicalOptimizationProblemWrapper()HierarchicalOptimizationProblemWrapper()fillInitialParameters()fillParametersMin()fillParametersMax()fillFilteredParams()getOptimizationOptions()setOptimizationOptions()getReporter()
- Class HierarchicalOptimizationWrapper
- Inheritance Relationships
- Class Documentation
parpe::HierarchicalOptimizationWrapperHierarchicalOptimizationWrapper()HierarchicalOptimizationWrapper()HierarchicalOptimizationWrapper()evaluate()evaluate()getDefaultScalingFactors()getDefaultOffsetParameters()getDefaultSigmaParameters()getUnscaledModelOutputsAndSigmas()computeAnalyticalScalings()applyOptimalScalings()computeAnalyticalOffsets()computeAnalyticalSigmas()applyOptimalOffsets()fillInAnalyticalSigmas()evaluateWithOptimalParameters()numParameters()numProportionalityFactors()getProportionalityFactorIndices()numOffsetParameters()numSigmaParameters()getOffsetParameterIndices()getSigmaParameterIndices()getAnalyticalParameterIndices()getWrappedFunction()getParameterIds()evaluate()
- Class MultiConditionDataProvider
- Inheritance Relationships
- Class Documentation
parpe::MultiConditionDataProvider~MultiConditionDataProvider()getNumberOfSimulationConditions()getSimulationToOptimizationParameterMapping()mapSimulationToOptimizationGradientAddMultiply()mapAndSetOptimizationToSimulationVariables()getParameterScaleOpt()getParameterScaleOpt()getParameterScaleSim()getParameterScaleSim()updateSimulationParametersAndScale()getExperimentalDataForCondition()getAllMeasurements()getAllSigmas()getNumOptimizationParameters()getProblemParameterIds()getModel()getSolver()
- Class MultiConditionDataProviderDefault
- Inheritance Relationships
- Class Documentation
parpe::MultiConditionDataProviderDefaultMultiConditionDataProviderDefault()~MultiConditionDataProviderDefault()getNumberOfSimulationConditions()getSimulationToOptimizationParameterMapping()mapSimulationToOptimizationGradientAddMultiply()mapAndSetOptimizationToSimulationVariables()getParameterScaleOpt()getParameterScaleOpt()getParameterScaleSim()getParameterScaleSim()updateSimulationParametersAndScale()getExperimentalDataForCondition()getAllMeasurements()getAllSigmas()getNumOptimizationParameters()getModel()getSolver()getProblemParameterIds()edata_
- Class MultiConditionDataProviderHDF5
- Inheritance Relationships
- Class Documentation
parpe::MultiConditionDataProviderHDF5MultiConditionDataProviderHDF5()MultiConditionDataProviderHDF5()MultiConditionDataProviderHDF5()MultiConditionDataProviderHDF5()~MultiConditionDataProviderHDF5()getNumberOfSimulationConditions()getSimulationToOptimizationParameterMapping()mapSimulationToOptimizationGradientAddMultiply()mapAndSetOptimizationToSimulationVariables()getParameterScaleOpt()getParameterScaleOpt()getParameterScaleSim()getParameterScaleSim()checkDataIntegrity()readFixedSimulationParameters()getExperimentalDataForCondition()getSensitivityParameterList()getAllMeasurements()getAllSigmas()getSigmaForSimulationIndex()getMeasurementForSimulationIndex()getOptimizationParametersLowerBounds()getOptimizationParametersUpperBounds()getNumOptimizationParameters()getModel()getSolver()updateSimulationParametersAndScale()copyInputData()getSimAndPreeqConditions()getReinitializationIndices()getHdf5File()setModel()getProblemParameterIds()updateFixedSimulationParameters()
- Class MultiConditionProblem
- Inheritance Relationships
- Class Documentation
parpe::MultiConditionProblemMultiConditionProblem()MultiConditionProblem()MultiConditionProblem()~MultiConditionProblem()earlyStopping()getDataProvider()getResultWriter()setInitialParameters()setParametersMin()setParametersMax()fillParametersMin()fillParametersMax()fillInitialParameters()getReporter()getTrainingData()
- Class OptimizationApplication
- Class Documentation
parpe::OptimizationApplicationOptimizationApplication()~OptimizationApplication()initProblem()run()runMaster()runSingleProcess()OperationTypefinalizeTiming()processResultFilenameCommandLineArgument()isMaster()isWorker()parseCliOptionsPreMpiInit()parseCliOptionsPostMpiInit()printUsage()logParPEVersion()shortOptionslongOptionsdataFileNameresultFileNamefirst_start_idxmultiStartOptimizationProblemproblemh5FileoperationTypeloadBalancerwithMPIinitMPI()
- Class Documentation
- Class OptimizationOptions
- Class Documentation
parpe::OptimizationOptionsOptimizationOptions()createOptimizer()toString()getIntOption()getDoubleOption()getStringOption()setOption()setOption()setOption()for_each()optimizerlogFileprintToStdoutmaxOptimizerIterationsnumStartsretryOptimizationhierarchicalOptimizationmultistartsInParallelfromHDF5()fromHDF5()getStartingPoint()
- Class Documentation
- Class OptimizationReporter
- Inheritance Relationships
- Class Documentation
parpe::OptimizationReporterOptimizationReporter()OptimizationReporter()evaluate()numParameters()starting()iterationFinished()beforeCostFunctionCall()afterCostFunctionCall()finished()getFinalCost()getFinalParameters()setGradientFunction()getParameterIds()result_writer_cpu_time_total_sec_cpu_time_iteration_sec_logger_printObjectiveFunctionFailureMessage()wall_timer_num_function_calls_num_iterations_num_parameters_started_grad_fun_have_cached_cost_have_cached_gradient_cached_gradient_cached_cost_cached_status_final_cost_cached_parameters_default_logger_prefix_
- Class OptimizationResultWriter
- Class Documentation
parpe::OptimizationResultWriterOptimizationResultWriter()OptimizationResultWriter()operator=()OptimizationResultWriter()~OptimizationResultWriter()logObjectiveFunctionEvaluation()logOptimizerIteration()setLoggingEachIteration()setLoggingEachFunctionEvaluation()starting()saveOptimizerResults()getH5File()getRootPath()setRootPath()logParametersEachFunctionEvaluationlogGradientEachFunctionEvaluationlogGradientEachIterationflushResultWriter()
- Class Documentation
- Class SimulationResultWriter
- Class Documentation
parpe::SimulationResultWriterSimulationResultWriter()SimulationResultWriter()SimulationResultWriter()SimulationResultWriter()~SimulationResultWriter()createDatasets()createDatasets()saveSimulationResults()saveTimepoints()saveMeasurements()saveModelOutputs()saveStates()saveParameters()saveLikelihood()reopenFile()saveXsaveLlhsaveYSimsaveYMessave_parameters_yMesPathySimPathxPathllhPathtimePathparametersPath
- Class Documentation