Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%ZEN] >  [Report] >  [Aggregate] >  [Correlation]
Private  Storage   

deprecatedclass %ZEN.Report.Aggregate.Correlation extends %ZEN.Report.CustomAggregate

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 2


Summary

Properties
Count SUMPRODXY SUMX SUMX2
SUMY SUMY2 accumIf class
escape excelFormula excelName excelNumberFormat
expression field fields filter
format ignoreNLS name postprocessResult
preprocessValue runtimeMode type uniqueId

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%PostProcessValue %PreProcessValue %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject GetResult ProcessValue
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
fieldIsValid nameIsValid


Properties

• property Count as %Integer [ InitialExpression = 0 ];
Number of values processed
• property SUMPRODXY as %Double [ InitialExpression = 0 ];
• property SUMX as %Double [ InitialExpression = 0 ];
• property SUMX2 as %Double [ InitialExpression = 0 ];
• property SUMY as %Double [ InitialExpression = 0 ];
• property SUMY2 as %Double [ InitialExpression = 0 ];

Methods

• method GetResult() as %String
Returns the correlation coefficient. Returns "" if the denominator would be zero
• method ProcessValue(pValue As %List) as %Status
ProcessValue is called sequentially on each record returned by the report query or queries.

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.