Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%DeepSee] >  [Query] >  [scalarFunction]
Private  Storage   

class %DeepSee.Query.scalarFunction extends %RegisteredObject

This class defines the set of scalar functions allowed within DeepSee queries.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
8


Summary

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %EvaluateScalar
%Extends %GetParameter %IsA %IsModified
%IsScalarFunction %New %NormalizeObject %ObjectModified
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject ISNULL LOG
LOOKUP POWER ROUND SQRT


Methods

• classmethod %EvaluateScalar(pFunc As %String, pValue1 As %String = "", pValue2 As %String = "", pValue3 As %String = "", pValue4 As %String = "") as %String
Evaluate the given scalar function, pFunc, and return the result.
• classmethod %IsScalarFunction(pFunc As %String) as %String
Test if pFunc is a scalar function. Return -1 if function is not a scalar function, otherwise return the number of arguments and (total number of) optional arguments (args:optargs) expected by the function.
• classmethod ISNULL(pValue As %Double, pReplacement As %Double) as %Double
IsNull scalar function: If value is "", return replacment,
• classmethod LOG(pValue As %Double) as %Double
Log base 10 scalar function.
• classmethod LOOKUP(pTermList As %String, pKey As %String, pDefault As %String = "", pField As %String = "") as %String
Lookup a value in a term list.
• classmethod POWER(pValue As %Double, pArg As %Double) as %Double
Power scalar function.
• classmethod ROUND(pValue As %Double, pDigits As %Integer = 0) as %Double
Round the given value to pDigits places.
• classmethod SQRT(pValue As %Double) as %Double
Square root scalar function.


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