[#BloombergLP-bdlsta-LineFit-yMeanIfValid]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlsta.adoc[bdlsta]::xref:BloombergLP/bdlsta/LineFit.adoc[LineFit]::yMeanIfValid
:relfileprefix: ../../../
:mrdocs:

Load the mean of the Y values into `result` when data is sufficient.

== Synopsis

Declared in `<bdlsta_linefit.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
yMeanIfValid(double* result) const;
----

== Description

Load into the specified `result`, the mean of the data set Y's. Return 0 on success, and a non‐zero value otherwise. Specifically, `e_INADEQUATE_DATA` is returned if `1 > count`.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| receives the mean of the Y values
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#