CModel.Bounds Parameters: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) mNo edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
Line 4: | Line 4: | ||
<onlyinclude>Calculates the confidence bounds on the parameter estimates of an associated cModel object. Returns a '''[[ParamBoundsValues Class|ParamBoundsValues]]''' object that represents the confidence bounds on the parameter estimates.'''</onlyinclude> | <onlyinclude>Calculates the confidence bounds on the parameter estimates of an associated cModel object. Returns a '''[[ParamBoundsValues Class|ParamBoundsValues]]''' object that represents the confidence bounds on the parameter estimates.'''</onlyinclude> | ||
{{Template:API_BoundsNote}} | |||
== Syntax== | == Syntax== |
Latest revision as of 19:02, 18 August 2016
Member of: SynthesisAPI.cModel
Calculates the confidence bounds on the parameter estimates of an associated cModel object. Returns a ParamBoundsValues object that represents the confidence bounds on the parameter estimates.
Remarks: Use the SetConfidenceLevel method to specify the confidence bound settings, and then use this method to perform the calculations. This method applies to published models only. Returns nothing if the calculation is performed on a non-published model.
Syntax
.Bounds_Parameters()
Example
This example assumes that a published model with ID #47 exists in the repository.
VBA ... 'Get model ID #47 from project ID #1 in the repository. Dim AModel As cModel MyRepository.Project.SetCurrentProject(1) Set AModel = MyRepository.Model.GetModel(47) 'Set the confidence level to 90% two-sided bounds. Dim ErrorMsg As String Call AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg) 'Calculate the bounds on the model's parameters. Dim ResultValue() As ParamBoundsValues ResultValue = AModel.Bounds_Parameters 'Output sample: Display the bounds on the first parameter. Dim ParamName As String Dim ParamUpperVal As Double Dim ParamLowerVal As Double ParamName = ResultValue(0).ParamName ParamUpperVal = ResultValue(0).Upper ParamLowerVal = ResultValue(0).Lower MsgBox (ParamName & ": " & ParamUpperVal & " and " & ParamLowerVal)
VB.NET ... 'Get model ID #47 from project ID #1 in the repository. Dim AModel As cModel MyRepository.Project.SetCurrentProject(1) Set AModel = MyRepository.Model.GetModel(47) 'Set the confidence level to 90% two-sided bounds. Dim ErrorMsg As String AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg) 'Calculate the bounds on the model's parameters. Dim ResultValue() As ParamBoundsValues ResultValue = AModel.Bounds_Parameters 'Output sample: Display the bounds on the first parameter. Dim ParamName As String Dim ParamUpperVal As Double Dim ParamLowerVal As Double ParamName = ResultValue(0).ParamName ParamUpperVal = ResultValue(0).Upper ParamLowerVal = ResultValue(0).Lower MsgBox (ParamName & ": " & ParamUpperVal & " and " & ParamLowerVal)