Difference between revisions of "Functions by category"

m
 
(63 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Function list (to be categorized)
+
[[Category:Functions]]
 +
<div style="column-count: 2;-moz-column-count:2;-webkit-column-count:2">
 +
Use this page to find a function, operator, attribute, etc. when you don't know its name. Look in the relevant category. If you do know its name, use the Search box (top left) or [[Alphabetical Function List]] and [[:Category: Functions]]
 +
__TOC__
 +
----
 +
 
 +
===  Language, control, and syntax ===
 +
{{Assista|key|List of control functions, operators and syntactic constructs in Analytica.}}
 +
'''[[Operators]]: '''[[Operators  | Arithmetic: + - * / ^]]  [[Comparison Operators |Comparison:  <  >  <>  <=  >=]]  [[Logical Operators |Logical:]] [[And]], [[Or]], [[Not]]; [[Text Concatenation Operator: & |Text concatenation &]], [[Subscript/Slice Operator |Subscript and slice:  x[I=x], x[@I=x] ]], [[IdentPred]], [[Assignment Operator := |Assignment :=]], [[Using References|Reference \ and Dereference #]]
 +
 
 +
'''[[IF a THEN b ELSE c|Conditionals]]:''' [[If-Then-Else]], [[Ifall-Then-Else]], [[Ifonly-Then-Else]], [[If0]], [[Ifpos]], [[Functions Min and Max#CondMin(X, cond, I), CondMax(X, cond, I)|CondMin]], [[Functions Min and Max#CondMin(X, cond, I), CondMax(X, cond, I)|CondMax]]
 +
 
 +
'''Grouped expressions:'''  [[Begin-End for Grouping Expressions |(expr; expr)]],  [[Begin-End for Grouping Expressions |BEGIN expr; expr END]]
 +
 
 +
'''Comments:''' { comment }, /* comment */
 +
 
 +
'''Local variable declarations:'''  [[Local Values|Local..Do]], [[LocalAlias..Do]], [[LocalIndex..Do|LocalIndex i]], [[Local Index Operator::A.I]]
 +
 
 +
'''iteration Loops:''' [[While..Do]], [[For..Do]]
 +
 
 +
=== Mathematics ===
 +
 
 +
'''[[Math functions|Basic math]]:''' [[Abs]], [[Sign]], [[Mod]], [[Round]], [[Ceil]], [[Floor]], [[Sqr]], [[Sqrt]], [[Exp]], [[Ln]], [[LogTen]], [[Degrees]], [[Radians]], [[Sigmoid]] {{Assista|key|List of basic built-in math functions.}}
 +
 
 +
'''[[Trig Functions]]:  '''[[Trig Functions| Sin, Cos, Tan]], [[Trig Functions| Sinh, Cosh, Tanh]], [[ArcSin]], [[ArcCos]], [[ArcTan]], [[ArcTan2]]; [[ArcSinH]],  [[ArcCosH]], [[ArcTanH]] {{Assista|key|List of trigonometric functions.}}
 +
 
 +
'''[[Set Functions]]: '''[[SetContains]], [[SetDifference]], [[SetEvaluationFlag]], [[SetIntersection]], [[SetUnion]] {{Assista|key|List of functions that manipulate sets of elements. A set is a represented as reference to a list.}}
 +
 
 +
'''[[Complex Numbers]]:''' [[Abs]], [[RealPart]], [[ImPart]], [[ComplexDegrees]], [[ComplexRadians]], [[Conj]] {{Assista|key|List of functions that operate on parts of complex numbers. Many numeric built-in functions also handle complex numbers.}}
 +
 
 +
'''Signal processing:''' [[FFT]], [[FFTInv]]
 +
 
 +
'''Combinatorics:''' [[Combinations]],  [[Permutations]], [[Factorial]], [[Partitions]] {{Assista|key|List of built-in combinatoric functions.}}
 +
 
 +
'''Bit functions:''' [[BitAnd]], [[BitCount]], [[BitNot]], [[BitOr]], [[BitShift]], [[BitXOr]], [[MantissaAndExponent]] {{Assista|key|List of built-in functions for accessing or combining the bits within an integer. Bit-level operations.}}
  
[[Category:Functions]]
+
'''Bessel and related functions:''' [[Airy_Ai]], [[Airy_Ai_deriv]], [[Airy_Ai_zero]], [[Airy_Bi]], [[Airy_Bi_deriv]], [[Airy_Bi_zero]], [[BesselJ]], [[BesselY]], [[BesselI]], [[BesselK]], [[BesselJzero]], [[BesselYzero]] {{Assista|key|List of Bessel and Airy functions.}}
(Back to [[Analytica Reference]])
 
  
See also: [[:Category:Functions|functions by category]].
+
=== Dates, Text, Financial===
[[Functions to be organized]]
+
'''[[Date and Time Values |Date and Time]]:'''[[Date_Functions#MakeDate.28year.2C_month.2C_day.29 | MakeDate]], [[MakeTime]] [[DateAdd]], [[DatePart]], [[Today]], [[ParseDate]], [[IsDateTime]], [[YearFrac]] {{Assista|key|List of built-in functions for dates and times (date-time numbers).}}
[[Rare and deprecated functions]]
 
  
== Language, control, and syntax ==
+
[[Text values |'''Text''']]''': ''' [[SelectText]], [[FindInText]], [[TextReplace]], [[SplitText]], [[JoinText]], [[Text Concatenation Operator: & |Text Concatenation: t1&t2]], [[TextLength]], [[TextLowerCase]], [[TextUpperCase]], [[TextSentenceCase]], [[TextTrim]], [[Asc]], [[Chr]], [[Formatted Text Literal|f"..."]], [[TextCharacterEncode]], [[TextDistance]], [[NumberToText]] {{Assista|key|List of built-in text functions.}}
'''[[Operators]]: '''[[Operators|Arithmetic: + - * / ^]]  [[Comparison Operators|Comparison]]: =  <  >  <>  <=  >=  [[Logical Operators|Logical]][[And]], [[Or]], [[Not]]; [[Text Concatenation Operator: &|Text concatenation]]: &; [[Subscript/Slice Operator|Subscript and slice:  x[I=x], x[@I=x] ]], [[Assignment Operator :=|Assignment :=]], [[Reference Operator::\|Reference \]], [[Dereference Operator|Dereference #]],  
 
  
'''Conditional constructs:''' [[If-Then-Else]], [[Ifall-Then-Else]], [[Ifonly-Then-Else]], [[If0]], [[Ifpos]]
+
'''[[:Category:Financial Functions |Financial]]''': [[Pv]], [[Fv]], [[Npv]], [[XNpv]], [[Rate]], [[NPer]], [[Pmt]], [[PPmt]], [[IPmt]], [[CumIPmt]], [[Irr]], [[XIrr]] {{Assista|key|List of built-in financial functions. }}
  
'''Loops:''' [[While..Do]], [[For..Do]]
+
=== Array functions ===
 +
{{Assista|key|List of built-in array functions in Analytica.}}
 +
'''[[Functions that create indexes|Make an Index]]: ''' [x, y], [[Sequence]],  [[Sequence Operator |Sequence Operator: first..last]], [[Concat]], [[SortIndex]], [[SplitText]], [[SubIndex]], [[Subset]], [[Unique]], [[Copyindex]] {{Assista|key|List of functions that create lists (for defining indexes).}}
  
'''Grouped expressions:''' [[Begin-End for Grouping Expressions|(expr; expr)]], [[Begin-End for Grouping Expressions|BEGIN expr; expr END]]
+
'''[[Functions that create arrays]]:''' [[Array]], [[Table]], [[SubTable]], [[MultiTable]], [[DetermTable]], [[ProbTable]], [[AddIndex]]  
  
'''Comments:''' { commented text }
+
'''[[Array-reducing functions|Array reducing]]: '''[[Sum]], [[Product]], [[Average]],[[Functions_Min_and_Max || Max]] [[Functions_Min_and_Max | Min]], [[ArgMin_and_ArgMax]], [[JoinText]], [[Functions_Min_and_Max | Condmax]], [[Functions_Min_and_Max | Condmin]], [[Area]]
  
'''Declaring local variables:''' [[Var..Do|VAR x]], [[Index..Do|Index i]][[MetaVar |MetaVar v]]; [[MetaIndex |MetaIndex i]]; [[Alias..Do|Alias a]], [[Local Index Operator::A.I]]  
+
'''[[Subscript and slice of a subarray|Subscript, selection, lookup]]: ''' [[Subscript and slice of a subarray|x[i=j]]], [[Slice]], [[Subscript]][[Subscript/Slice Operator|Slice Operator: [@I=n]]], [[StepInterp]]
  
==Mathematics==
+
'''[[Transforming functions|Array transforming]]: '''[[Cumulate]], [[Uncumulate]], [[CumProduct]], [[CumMax]], [[CumMin]], [[Normalize]], [[Integrate]], [[Rank]], [[Sort]], [[Aggregate]]
'''Basic math:''' [[Abs]], [[Sign]], [[Mod]], [[Round]], [[Ceil]], [[Floor]], [[Sqr]], [[Sqrt]], [[Exp]], [[Ln]], [[LogTen]], [[Factorial]], [[Degrees]], [[Radians]]
 
  
'''Trigonometry: '''[[Trig Functions| Sin, Cos, Tan]][[Trig Functions| Sinh, Cosh, Tanh]]; [[ArcSin]], [[ArcCos]], [[ArcTan]], [[ArcTan2]]; [[ArcSinH]],  [[ArcCosH]], [[ArcTanH]]
+
'''[[Interpolation functions|Interpolation]]: '''[[StepInterp]], [[LinearInterp]], [[CubicInterp]], [[MonoCubicInterp]] {{Assista|key|List of built-in interpolation functions.}}
  
'''[[Set Functions|Set functions]]: '''[[SetContains]], [[SetDifference]], [[SetEvaluationFlag]], [[SetIntersection]], [[SetUnion]]
+
'''[[Matrix functions|Matrix]]: '''[[MatrixMultiply]], [[Transpose]], [[Invert]], [[Determinant]], [[Decompose]], [[EigenDecomp]], [[SingularValueDecomp]], [[VectorCrossProduct]] {{Assista|key|List of built-in matrix functions}}
  
'''[[Complex Numbers|Complex numbers]]:''' [[RealPart]], [[ImPart]], [[ComplexDegrees]], [[ComplexRadians]], [[Conj]]
+
'''Information about arrays: '''[[Size]], [[IndexesOf]], [[IndexLength]], [[IndexNames]], [[HasImplicitDimension]], [[HasIndex]], [[MemoryInUseBy]]
  
==Statistics and Probability distributions==
+
'''[[Relational tables and multiD arrays|Relational tables]]: '''[[MdTable]], [[MdArrayToTable]]
'''[[Statistics]]: '''[[Median]], [[Mean]],  [[SDeviation]], [[Variance]], [[Skewness]], [[Kurtosis]], [[Statistics]], [[Probability]], [[GetFract]],  [[ProbBands]], [[Correlation]], [[RankCorrel]], [[Regression]], [[Cdf]], [[Pdf]]
 
  
'''Custom distributions: '''[[CumDist]], [[Fractiles]], [[ChanceDist]], [[ProbDist]], [[ProbTable]], [[Random]]
+
'''Other array functions: '''[[Aggregate]]
  
'''Discrete distributions: '''[[Bernoulli]], [[Binomial]], [[NegativeBinomial]], [[Combinations]],  [[Permutations]], [[Geometric]], [[HyperGeometric]], [[Certain]]
+
=== Statistics and Probability distributions ===
 +
{{Assista|key|List of probability distribution functions.}}
 +
'''[[Statistical functions|Statistics]]: '''[[Median]], [[Mean]],  [[SDeviation]], [[Variance]], [[Skewness]], [[Kurtosis]], [[Statistics]], [[Probability]], [[Frequency]], [[GetFract]],  [[ProbBands]], [[Correlation]], [[RankCorrel]], [[Regression]], [[Cdf]], [[Pdf]] {{Assista|key|List of statistical functions.}}
  
'''Continuous distribution functions: '''[[Uniform]], [[Normal]], [[LogNormal]], [[Beta]], [[Triangular]], [[Poisson]], [[Exponential]], [[Gamma]], [[StudentT]], [[Weibull]], [[Wilcoxon]], [[Logistic]], [[BesselJ]], [[BesselY]], [[BesselI]], [[BesselK]], [[ChiSquared]]
+
'''[[Custom continuous distributions]]: '''[[CumDist]], [[ProbDist]], [[Fractiles]], [[Keelin]]
  
'''Modifying distributions: ''' [[Mid]], [[Sample]], [[Truncate]], [[Shuffle]]
+
'''[[Custom discrete probabilities]]:''' [[ChanceDist]], [[ProbTable]], [[Determtable]], [[Random]]
  
'''Functions for distributions: '''[[ProbWilcoxon]], [[CumWilcoxon]], [[CumWilcoxonInv]], [[BetaI]], [[BetaIInv]], [[GammaI]], [[GammaIInv]], [[CumNormal]], [[CumNormalInv]]
+
'''[[Parametric discrete distributions]]: '''[[Bernoulli]], [[Binomial]], [[NegativeBinomial]], [[Poisson]], [[Geometric]], [[HyperGeometric]], [[Certain]], [[Uniform]], [[Wilcoxon]]
 +
:'''Corresponding probability functions:''' <code>Prob*(k,...)</code>, e.g., [[ProbPoisson]]
 +
:'''Corresponding cumulative probability functions:''' <code>Cum*(k,...)</code>, e.g., [[CumPoisson]]
 +
:'''Corresponding quantile functions:''' <code>Cum*Inv(p,...)</code>, e.g., [[CumPoissonInv]]
  
'''SIPs and SLURPs: '''[[SipDecode]], [[SipEncode]]
+
'''[[Parametric continuous distributions]]: '''[[Beta]], [[ChiSquared]],  [[Exponential]], [[FDist]], [[Gamma]], [[Gaussian]], [[Logistic]],  [[LogNormal]], [[Normal]], [[StudentT]], [[Triangular]], [[UncertainLMH]], [[Uniform]], [[Weibull]]. 
 +
:'''Corresponding density functions:''' <code>Dens*(x, ...)</code>, e.g., [[DensBeta]]
 +
:'''Corresponding cumulative probability functions:''' <code>Cum*(x,...)</code>, e.g., [[CumBeta]]
 +
:'''Corresponding quantile functions:''' <code>Cum*Inv(p,...)</code>, e.g., [[CumBetaInv]]
  
=== Other types of data ===
+
'''[[Special probabilistic functions|Special and modifying distributions]]: ''' [[Mid]], [[Certain]], [[Sample]], [[Truncate]], [[Shuffle]], [[Random]]
'''[[Date and Time Values|Date and Time]]:'''[[Date_Functions#MakeDate.28year.2C_month.2C_day.29| MakeDate]], [[DateAdd]], [[DatePart]], [[Today]], [[ParseDate]], [[IsDateTime]]
 
  
[[Text values|'''Text''']]''': '''[[SelectText]], [[FindInText]], [[TextReplace]], [[SplitText]], [[JoinText]], [[Text Concatenation Operator: &|Text Concatenation: t1&<nowiki/>t2]], [[TextLength]], [[TextLowerCase]], [[TextUpperCase]], [[TextSentenceCase]], [[TextTrim]]
+
'''[[Statistics, Sensitivity, and Uncertainty Analysis|Sensitivity analysis]]:''' [[Dydx]], [[Elasticity]], [[Importance analysis]], [[Correlation]], [[RankCorrel]], [[Regression]], [[WhatIf]], [[WhatIfAll]] , [[Tornado charts]], [[X-Y plots]], [[Scatter plots]] {{Assista|key|List of functions for sensitivity analysis.}}
  
'''[[:Category:Financial Functions|Financial]]''': [[Pv]], [[Fv]], [[Npv]], [[XNpv]], [[Rate]], [[NPer]], [[Pmt]], [[PPmt]], [[IPmt]], [[CumIPmt]], [[Irr]], [[XIrr]]<nowiki/>
+
'''Functions for distributions: '''[[ProbWilcoxon]], [[CumWilcoxon]], [[CumWilcoxonInv]], [[BetaI]], [[BetaIInv]], [[GammaI]], [[GammaIInv]], [[CumNormal]], [[CumNormalInv]], [[Erf]], [[ErfInv]]
  
=== Array functions ===
+
'''[[Stochastic Information Packets (SIPs)|SIPs and SLURPs]]: '''[[SipDecode]], [[SipEncode]]
'''Make an Index: '''[[Sequence]],  [[Sequence Operator|Sequence Operator: first..last]], [[SortIndex]], [[SplitText]], [[SubIndex]], [[Subset]], [[Unique]]
 
  
'''[[:Category:Array-reducing functions|Array reducing]]: '''[[Sum]], [[Product]], [[Average]],[[Functions_Min_and_Max| Max]] [[Functions_Min_and_Max| Min]], [[ArgMin_and_ArgMax]], [[JoinText]], [[Functions_Min_and_Max| Condmax]], [[Functions_Min_and_Max| Condmin]], [[Area]]
+
'''Distribution Variations.ana:''' [[Beta_m_sd]], [[Erlang]], [[Gamma_m_sd|Gamma_m_sd]], [[InverseGaussian]], [[LogNormal_m_sd]], [[Lorenzian]], [[Normal_p1_p2]], [[Pareto]], [[Pert]], [[Rayleigh]], [[Smooth_Fractile]], [[Triangular10_50_90]], [[Triangular10_Mode_90]], [[Wald]], [[Warp_dist]], [[Weibull_10_50_90]].
  
'''Subscript, selection, lookup: '''[[Slice]], [[Subscript]], [[Subscript/Slice Operator|Slice Operator: [@I=n]]], [[StepInterp]]
+
'''Multivariate Distributions.ana: ''' [[BiNormal]], [[Correlate_dists]], [[Correlate_with]], [[Dirichlet]], [[Dist_additive_growth]], [[Dist_compound_growth]], [[Dist_reshape]], [[Dist_serial_correl]], [[InvertedWishart]], [[Multinomial]], [[MultiNormal]], [[MultiUniform]], [[Normal_additive_gro]], [[Normal_compound_gro]], [[Normal_correl]], [[Normal_serial_correl]], [[RegressionDist]], [[UniformSpherical]], [[Wishart]]
  
'''Array mapping: '''[[Cumulate]], [[Uncumulate]], [[CumProduct]], [[Normalize]], [[Integrate]], [[Rank]], [[Sort]], [[Aggregate]]
+
'''Distribution Densities.ana:''' [[LDens_InvertedWishart]], [[LDens_Wishart]]
  
'''Tables and functions to make arrays: '''[[Array]], [[Table]], [[SubTable]], [[MultiTable]], [[DetermTable]], [[ProbTable]], [[AddIndex]]
+
'''Power law distribution library.ana:''' [[PowerLawDist]], [[CumPowerLawDist]], [[CumPowerLawDistInv]], [[DensPowerLawDist]]
  
'''Interpolation: '''[[StepInterp]], [[LinearInterp]], [[CubicInterp]], [[MonoCubicInterp]]
+
===  User interaction and dialogs ===
 +
{{Assista|key|List of built-in functions for user interaction.}
 +
'''User input:''' [[Choice menu user input|Choice]], [[Checkbox]], [[MultiChoice]], [[Choice menus and Checkboxes in an edit table|Choices & Checkboxes in an Edit table]]
  
'''Matrix: '''[[MatrixMultiply]], [[Transpose]], [[Invert]], [[Determinant]], [[Decompose]], [[EigenDecomp]], [[SingularValueDecomp]]
+
'''[[Dialog Functions]]: '''[[Dialog Functions#MsgBox|MsgBox]], [[Error]], [[AskMsgText]], [[AskMsgChoice]], [[AskMsgNumber]], [[ShowProgressBar]]
  
'''Information about arrays: '''[[Size]], [[IndexesOf]], [[IndexNames]], [[MemoryInUseBy]]
+
'''Controlling the interface''': [[ChangeNodeVisibility]], [[CloseWindow]], [[ShowWindow]]
  
'''Relational tables: '''[[MdTable]], [[MdArrayToTable]]
+
'''Debugging:''' [[ConsolePrint]]
  
'''Other array functions: '''[[Aggregate]]
+
'''Drawing functions:''' [[Canvas]], [[CanvasContext]], [[CanvasDrawEllipse]], [[CanvasDrawImage]], [[CanvasDrawLine]], [[CanvasDrawPixel]], [[CanvasDrawPolygon]], [[CanvasDrawRectangle]], [[CanvasDrawText]], [[CanvasImage]], [[GraphToCanvasCoord]], [[ImageInfo]]. {{Assista|key|List of canvas drawing functions.}}
'''
 
  
== User interaction and dialog ==
+
'''Cell-level format functions:''' [[CellAlignment]], [[CellBar]], [[CellBorder]], [[CellComparisonFormat]], [[CellEntry]], [[CellFill]], [[CellFont]], [[CellFormats]], [[CellIcon]], [[CellNumberFormat]], [[CellOnClick]], [[CellSpan]] {{Assista|key|List of cell formatting functions.}}
'''User input:''' [[Choice| Choice]], [[Checkbox]]
 
  
'''Dialog boxes: '''[[MsgBox]], [[Error]], [[AskMsgText]], [[AskMsgChoice]], [[AskMsgNumber]], [[ShowProgressBar]]
+
'''Graph annotations:''' In '''OnGraphDraw annotations.ana''': [[Plot_error_bars]], [[Plot_Tukey_bars]], [[Plot_point_labels]], [[Plot_solid_band]], [[Plot_solid_prob_band]], [[Clip_to_PlotArea]], [[Apply_slicers_to_val]]. In '''Google Maps from OnGraphDraw.ana''': [[OnDraw_Google_map]], [[Test_map_pivot_vars]], [[Test_map_pivot_slice]]. {{Assista|key|List of functions for graph annotations.}}{{Assista||(These will be used from the OnGraphDraw attribute)}}
  
== Types and type conversion ==
+
==Types and type conversion ===
 +
{{Assista|key|List of data type and data type conversion funtions.}}
 
'''Convert type: '''[[Chr]], [[Asc]], [[NumberToText]], [[ParseDate]], [[ParseNumber]]
 
'''Convert type: '''[[Chr]], [[Asc]], [[NumberToText]], [[ParseDate]], [[ParseNumber]]
  
'''Get or test type:''' [[Data_Type_Functions#Function_TypeOf| TypeOf]], [[IsDateTime]], [[IsHandle]], [[Data_Type_Functions#Function_IsNaN| IsNaN]], [[IsNull]],[[Data_Type_Functions#Function_IsNumber| IsNumber]], [[IsRealNumber]],[[Data_Type_Functions#Function_IsReference| IsReference]],[[Data_Type_Functions#Function_IsText| IsText]], [[Data_Type_Functions#Function_IsUndef| IsUndef]], [[IsResultComputed]], [[Data_Type_Functions#Function_IsNotSpecified|IsNotSpecified]]
+
'''[[Data Type Functions]]:''' [[Data_Type_Functions#Function_TypeOf | TypeOf]], [[IsDateTime]], [[IsHandle]], [[Data_Type_Functions#Function_IsNaN | IsNaN]], [[IsNull]],[[Data_Type_Functions#Function_IsNumber | IsNumber]], [[IsRealNumber]],[[Data_Type_Functions#Function_IsReference | IsReference]],[[Data_Type_Functions#Function_IsText | IsText]], [[Data_Type_Functions#Function_IsUndef | IsUndef]], [[IsResultComputed]], [[Data_Type_Functions#Function_IsNotSpecified |IsNotSpecified]], [[ComparisonPart]]
== Integration with other applications ==
+
 
 +
=== Optimizer functions ===
 +
{{Assista|key|List of optimization functions.}}
 +
'''[[Primary Optimization Functions|Optimizer formulation]]: ''' [[DefineOptimization]],  [[OptSolution]], [[OptInfo]], [[OptObjective]],  [[GroupedInteger]], [[OptGuess]], [[OptEngineInfo]]
 +
 
 +
'''[[Optimization Status Functions|Optimizer diagnostics]]:''' [[OptStatusNum]], [[OptStatusText]], [[OptFindIIS]], [[OptWriteIIS]],  [[OptObjectiveSa]], [[OptRead]], [[OptWrite]], [[OptReducedCost]], [[OptRhsSa]], [[OptScalarToConstraint]], [[OptScalarToDecision]], [[OptShadow]], [[OptSlack]]
  
* [[RunConsoleProcess]]
+
=== Integration with other applications ===
'''Reading and writing data: '''[[ReadFromUrl]], [[OpenURL]], [[ReadImageFile]], [[ReadTextFile]], [[WriteTextFile]], [[ShowPdfFile]]
+
{{Assista|key|List of functions for reading or writing data.}}{{Assista|key|List of functions for working with spreadsheets.}}{{Assista|key|List of functions for querying or writing to ODBC databases.}}{{Assista|key|List of functions for application integration.}}
 +
'''Reading and writing data: '''[[ReadFromUrl]], [[OpenURL]], [[ReadImageFile]], [[WriteImageFile]], [[ReadTextFile]], [[WriteTextFile]], [[ReadBinaryFile]], [[WriteBinaryFile]], [[ReadExportFile]], [[ShowPdfFile]]
  
'''Spreadsheet access: '''[[SpreadsheetOpen]], [[SpreadsheetCell]], [[SpreadsheetRange]], [[SpreadsheetSetCell]], [[SpreadsheetSetRange]],[[SpreadsheetSave]],,  [[SpreadsheetInfo]], [[SpreadsheetSetInfo]]
+
'''Spreadsheet access: '''[[SpreadsheetOpen]], [[SpreadsheetCell]], [[SpreadsheetRange]], [[SpreadsheetSetCell]], [[SpreadsheetSetRange]],[[SpreadsheetSave]],  [[SpreadsheetInfo]], [[SpreadsheetSetInfo]]
  
 
'''Database and ODBC access: '''[[SqlDriverInfo]], [[DbLabels]], [[DbQuery]], [[DbTable]], [[DbTablenames]], [[DbWrite]], [[MdxQuery]]
 
'''Database and ODBC access: '''[[SqlDriverInfo]], [[DbLabels]], [[DbQuery]], [[DbTable]], [[DbTablenames]], [[DbWrite]], [[MdxQuery]]
  
'''[[COM Integration|COM API]]: '''[[COMArray]], [[COMCallMethod]], [[COMCreateObject]], [[COMGetProperty]]
+
'''Run other applications:''' [[RunConsoleProcess]]
 +
 
 +
'''[[COM Integration]]: '''[[COMArray]], [[COMCallMethod]], [[COMCreateObject]], [[COMGetProperty]], [[COMPutProperty]], [[COMEnumerate]]
 +
 
 +
'''[[:category:File_system_functions|File System Functions]]:''' [[CurrentDataFolder]], [[CurrentModelFolder]],  [[FileFullPath]], [[FilePathPart]], [[FileSystemCopy]], [[FileSystemDelete]], [[FileSystemListing]], [[FileSystemMove]], [[FileSystemNewFolder]].
  
'''Error handling:''' [[Error]], [[IgnoreWarnings]], [[Try]], [[ReThrow]]
+
'''[[Parsing and formatting data]]:''' [[ParseCSV]], [[MakeCSV]], [[ParseJSON]], [[MakeJSON]], [[ParseNumber]], [[ParseDate]], [[NumberToText]], [[Formatted Text Literals|f"..."]]. See also [[Parsing_and_formatting_data#XML|XML]].
  
 +
=== Special functions ===
  
Miscellaneous:  
+
'''[[Meta-inference]]:''' [[Handle]], [[Handle Functions#HandleFromIdentifier|HandleFromIdentifier]], [[Handle Functions#ListOfHandles|ListOfHandles]], [[FindObjects]], [[Dereference Operator::# |Dereference Operator: #R]] [[VarTerm Functions#Function_IndexesOf | IndexesOf]], [[IndexNames]], [[VarTerm Functions#Function_GetVariableByName | GetVariableByName]], [[IndexValue]], [[AttribGet]], [[InvalidateResult]] {{Assista|key|List of functions use or get Handles. }}
* [[Discrete]]
 
* [[Dispatch]]
 
  
[[Domain Expressions|'''Domain expressions''']]: [[Continuous]], [[Discrete]], [[Integer]], [[Boolean]] and [[Discrete]]
+
'''[[Evaluation Modes|Evaluation]]:''' [[Mid]], [[Sample]], [[Evaluate]], [[EvaluateScript]], [[GetEvaluationContext]] {{Assista|key|List of functions that evaluate expressions.}}
  
'''[[Domain Access Functions]]: '''[[Domain Access Functions|DomainType, DomainType, DomainLowerBound, DomainUpperBound, DomainIntegerGroup]]
+
'''Error handling:''' [[Error]], [[IgnoreWarnings]], [[Try]], [[Try|ReThrow]], [[Error Message Types]] {{Assista|key|List of functions for handling errors or exceptions.}}
  
== Objects and meta-inference ==
+
'''Miscellaneous:''' [[Discrete]], [[Dispatch]], [[FunctionOf]], [[Dynamic]], [[Iterate]], [[FindPolynomialZeroes]]
  
* [[ListOfHandles]], [[Dereference Operator::#|Dereference Operator: #R]] [[VarTerm Functions#Function_IndexesOf| IndexesOf]], [[IndexNames]], [[VarTerm Functions#Function_GetVariableByName| GetVariableByName]], [[IndexValue]], [[AttribGet]]
+
'''[[Domain Expressions]]: '''[[Continuous]], [[Discrete]], [[Integer]], [[Boolean]] and [[Discrete]] {{Assista|key|List of functions for declaring the domain type.}}
  
=== User modifiable attributes ===
+
'''[[Domain Access Functions]]: ''' [[Domain Access Functions|DomainType, DomainType, DomainLowerBound, DomainUpperBound, DomainIntegerGroup]]
  
=== Other common attributes ===
+
=== [[Attributes]] ===
  
=== Rare attributes ===
+
'''[[Attributes|Editable attributes for variables]]:''' [[Class]], [[Identifier]], [[Title]], Units, [[Description]], [[Definition]], [[Check attribute|Check]], [[Domain]], [[MetaIndex]], [[Manage attributes#Attributes dialog|User-defined attributes]]
'''Sensitivity analysis:''' [[Dydx]], [[Elasticity]], [[WhatIf]], [[WhatIfAll]]
 
  
=== Special ===
+
'''User editable for Functions:''' [[Parameters]], [[Recursion|Recursive]]
  
* [[Dynamic]]
+
'''User editable for Models, Modules, and Libraries:''' [[Attributes#Editable Attributes of Modules|Author, Savedate, Filename]]
'''[[Evaluation Modes|Evaluation]]:''' [[Mid]], [[Sample]], [[Evaluate]], [[EvaluateScript]], [[GetEvaluationContext]]
 
  
=== Analytica environment information ===
+
'''Computed attributes:''' [[Value]], Probvalue, [[Inputs]], [[Outputs]]
  
* [[AnalyticaLicenseInfo]], [[GetProcessInfo]], [[GetRegistryValue]], [[MemoryInUseBy]]
+
'''Internal:''' Diagwindow, ObjectWindow.
  
== Function parameter qualifiers ==
+
=== [[Classes of variables and other objects|Classes of Object]]===
  
* Type: [[Boolean]], [[Integer]], Index, Variable, Handle
+
[[Classes of variables and other objects|Decision, Chance, Objective, Variable, Moduke, Index, Constant, Function, Button, Text node, Constrain, Gradient, User input, User output, Frame node, Module, Model]], [[Filed_modules_and_libraries|Linked module, Library, Linked Library, Form]] {{Assista|key|List of Object classes in Analytica.}}
* Optional, Repeated
 
* Scalar, Vector, Array
 
  
== Functions still to be categorized ==
+
=== System variables ===
[[Erf]], [[ErfInv]]
+
'''Common:''' [[Run]], [[SampleSize]], [[Time]]
  
[[FFT]], [[FFTInv]]
+
'''System info''': [[AnalyticaLicenseInfo]], [[GetProcessInfo]], [[GetRegistryValue]], [[MemoryInUseBy]]
  
[[Frequency]]
+
===  [[Function parameter qualifiers]] ===
 +
'''[[Function parameter qualifiers#Data type qualifiers|Data types]]''': [[Function parameter qualifiers#Number|Number]], [[Function parameter qualifiers#Text|Text]], [[Function parameter qualifiers#Positive|Positive]], [[Function parameter qualifiers#NonNegative|NonNegative]], [[Function parameter qualifiers#Ascending|Ascending]], [[Function parameter qualifiers#Descending|Descending]], [[Function parameter qualifiers#Reference |Reference]],  [[Function parameter qualifiers#Handle|Handle]], [[Function parameter qualifiers#Coerce <type>|Coerce <type>]]  
  
[[FunctionOf]]
+
'''Object class:''' [[Function parameter qualifiers#Index|Index]], [[Function parameter qualifiers#Variable|Variable]],  [[Function parameter qualifiers#Object|Object]]
  
[[Iterate]], [[FindPolynomialZeroes]]
+
'''[[Function parameter qualifiers#Optional and repeated parameters|Optional and repeated parameters]]''': [[Function parameter qualifiers#Optional qualifier|Optional]], [[Function parameter qualifiers#Default values|Default]], [[Function parameter qualifiers#Repeated parameters (...)|Repeated parameters (...)]]
  
[[Join]]
+
'''[[Function parameter qualifiers#Dimensionality qualifiers|Arrays]]''': [[Function parameter qualifiers#Atom|Atom or scalar]], [[Function parameter qualifiers#Vector|Vector]], [[Function parameter qualifiers#Array|Array]], [[Function parameter qualifiers#Reduced|Reduced]]
  
(Multivariate Distributions.ana)
+
===  Libraries ===
  
[[GCD]]                   ([[media:GCD function library.ana|GCD function library.ana]])
+
[[Standard libraries]], [[Additional libraries]],
 +
'''GCD function library.ana: ''' [[GCD]]
  
 
'''Optimization Functions.ana:''' [[GoalSeek]], [[Gradient]]
 
'''Optimization Functions.ana:''' [[GoalSeek]], [[Gradient]]
Line 153: Line 198:
  
 
'''ODBC Library.ana:''' [[InsertRecSql]],  
 
'''ODBC Library.ana:''' [[InsertRecSql]],  
 
'''Distribution Variations.ana:''' [[Gamma_m_sd|Gamma_m_sd]], [[GammaFn]], [[GammaI]], [[GammaIInv]], [[InverseGaussian]], [[InvertedWishart]], [[Lorenzian]], [[NegBinomial]]
 
 
'''Distribution Densities.ana:''' [[LDens_InvertedWishart]], [[LDens_Wishart]], [[LGamma]]
 
  
 
'''Generalized Regression.ana:''' [[InvLogit]], [[Logistic_Regression]], [[Logit]]
 
'''Generalized Regression.ana:''' [[InvLogit]], [[Logistic_Regression]], [[Logit]]
 
'''Multivariate Distributions.ana: '''[[Gaussian]], [[Multinomial]], [[MultiNormal]], [[MultiUniform]], [[Normal_additive_gro]], [[Normal_compound_gro]], [[Normal_correl]], [[Normal_serial_correl]]
 
  
 
'''Linked List Library.ana:''' [[LL_First]], [[LL_Length]], [[LL_Nth]], [[LL_Push]], [[LL_Remove_First]], [[LL_To_Array]], [[LL_to_RArray]]
 
'''Linked List Library.ana:''' [[LL_First]], [[LL_Length]], [[LL_Nth]], [[LL_Push]], [[LL_Remove_First]], [[LL_To_Array]], [[LL_to_RArray]]
== Optimizer functions ==
 
DefineOptimization, [[OptInfo]], [[OptObjective]], [http://wiki.analytica.com/OptSolution OptSolution], [http://wiki.analytica.com/OptStatusNum OptStatusNum], [http://wiki.analytica.com/OptStatusText OptStatusText], [[OptEngineInfo]], [[GroupedInteger]], [[OptFindIIS]],[[OptWriteIIS]],  [[OptGuess]]
 
 
[[OptObjectiveSa]], [[OptRead]], [[OptWrite]], [[OptReducedCost]], [[OptRhsSa]], [[OptScalarToConstraint]], [[OptScalarToDecision]], [[OptShadow]], [[OptSlack]]
 
  
=== Obsolete optimizer functions:  ===
+
</div>
[[LpDefine]], [[LpFindIIS]], [[LpObjSa]], [[LpOpt]], [[LpRead]], [[LpReducedCost]], [[LpRhsSa]], [[LpShadow]], [[LpSlack]], [[LpSolution]], [[LpStatusNum]], [[LpStatusText]], [[LpWrite]], [[LpWriteIIS]], [[NlpDefine]]
 

Latest revision as of 17:31, 5 February 2025

Use this page to find a function, operator, attribute, etc. when you don't know its name. Look in the relevant category. If you do know its name, use the Search box (top left) or Alphabetical Function List and Category: Functions


Language, control, and syntax

Operators: Arithmetic: + - * / ^ Comparison: < > <> <= >= Logical: And, Or, Not; Text concatenation &, Subscript and slice: x[I=x], x[@I=x] , IdentPred, Assignment :=, Reference \ and Dereference #

Conditionals: If-Then-Else, Ifall-Then-Else, Ifonly-Then-Else, If0, Ifpos, CondMin, CondMax

Grouped expressions: (expr; expr), BEGIN expr; expr END

Comments: { comment }, /* comment */

Local variable declarations: Local..Do, LocalAlias..Do, LocalIndex i, Local Index Operator::A.I

iteration Loops: While..Do, For..Do

Mathematics

Basic math: Abs, Sign, Mod, Round, Ceil, Floor, Sqr, Sqrt, Exp, Ln, LogTen, Degrees, Radians, Sigmoid

Trig Functions: Sin, Cos, Tan, Sinh, Cosh, Tanh, ArcSin, ArcCos, ArcTan, ArcTan2; ArcSinH, ArcCosH, ArcTanH

Set Functions: SetContains, SetDifference, SetEvaluationFlag, SetIntersection, SetUnion

Complex Numbers: Abs, RealPart, ImPart, ComplexDegrees, ComplexRadians, Conj

Signal processing: FFT, FFTInv

Combinatorics: Combinations, Permutations, Factorial, Partitions

Bit functions: BitAnd, BitCount, BitNot, BitOr, BitShift, BitXOr, MantissaAndExponent

Bessel and related functions: Airy_Ai, Airy_Ai_deriv, Airy_Ai_zero, Airy_Bi, Airy_Bi_deriv, Airy_Bi_zero, BesselJ, BesselY, BesselI, BesselK, BesselJzero, BesselYzero

Dates, Text, Financial

Date and Time: MakeDate, MakeTime DateAdd, DatePart, Today, ParseDate, IsDateTime, YearFrac

Text: SelectText, FindInText, TextReplace, SplitText, JoinText, Text Concatenation: t1&t2, TextLength, TextLowerCase, TextUpperCase, TextSentenceCase, TextTrim, Asc, Chr, f"...", TextCharacterEncode, TextDistance, NumberToText

Financial: Pv, Fv, Npv, XNpv, Rate, NPer, Pmt, PPmt, IPmt, CumIPmt, Irr, XIrr

Array functions

Make an Index: [x, y], Sequence, Sequence Operator: first..last, Concat, SortIndex, SplitText, SubIndex, Subset, Unique, Copyindex

Functions that create arrays: Array, Table, SubTable, MultiTable, DetermTable, ProbTable, AddIndex

Array reducing: Sum, Product, Average,| Max Min, ArgMin_and_ArgMax, JoinText, Condmax, Condmin, Area

Subscript, selection, lookup: x[i=j], Slice, Subscript, Slice Operator: [@I=n], StepInterp

Array transforming: Cumulate, Uncumulate, CumProduct, CumMax, CumMin, Normalize, Integrate, Rank, Sort, Aggregate

Interpolation: StepInterp, LinearInterp, CubicInterp, MonoCubicInterp

Matrix: MatrixMultiply, Transpose, Invert, Determinant, Decompose, EigenDecomp, SingularValueDecomp, VectorCrossProduct

Information about arrays: Size, IndexesOf, IndexLength, IndexNames, HasImplicitDimension, HasIndex, MemoryInUseBy

Relational tables: MdTable, MdArrayToTable

Other array functions: Aggregate

Statistics and Probability distributions

Statistics: Median, Mean, SDeviation, Variance, Skewness, Kurtosis, Statistics, Probability, Frequency, GetFract, ProbBands, Correlation, RankCorrel, Regression, Cdf, Pdf

Custom continuous distributions: CumDist, ProbDist, Fractiles, Keelin

Custom discrete probabilities: ChanceDist, ProbTable, Determtable, Random

Parametric discrete distributions: Bernoulli, Binomial, NegativeBinomial, Poisson, Geometric, HyperGeometric, Certain, Uniform, Wilcoxon

Corresponding probability functions: Prob*(k,...), e.g., ProbPoisson
Corresponding cumulative probability functions: Cum*(k,...), e.g., CumPoisson
Corresponding quantile functions: Cum*Inv(p,...), e.g., CumPoissonInv

Parametric continuous distributions: Beta, ChiSquared, Exponential, FDist, Gamma, Gaussian, Logistic, LogNormal, Normal, StudentT, Triangular, UncertainLMH, Uniform, Weibull.

Corresponding density functions: Dens*(x, ...), e.g., DensBeta
Corresponding cumulative probability functions: Cum*(x,...), e.g., CumBeta
Corresponding quantile functions: Cum*Inv(p,...), e.g., CumBetaInv

Special and modifying distributions: Mid, Certain, Sample, Truncate, Shuffle, Random

Sensitivity analysis: Dydx, Elasticity, Importance analysis, Correlation, RankCorrel, Regression, WhatIf, WhatIfAll , Tornado charts, X-Y plots, Scatter plots

Functions for distributions: ProbWilcoxon, CumWilcoxon, CumWilcoxonInv, BetaI, BetaIInv, GammaI, GammaIInv, CumNormal, CumNormalInv, Erf, ErfInv

SIPs and SLURPs: SipDecode, SipEncode

Distribution Variations.ana: Beta_m_sd, Erlang, Gamma_m_sd, InverseGaussian, LogNormal_m_sd, Lorenzian, Normal_p1_p2, Pareto, Pert, Rayleigh, Smooth_Fractile, Triangular10_50_90, Triangular10_Mode_90, Wald, Warp_dist, Weibull_10_50_90.

Multivariate Distributions.ana: BiNormal, Correlate_dists, Correlate_with, Dirichlet, Dist_additive_growth, Dist_compound_growth, Dist_reshape, Dist_serial_correl, InvertedWishart, Multinomial, MultiNormal, MultiUniform, Normal_additive_gro, Normal_compound_gro, Normal_correl, Normal_serial_correl, RegressionDist, UniformSpherical, Wishart

Distribution Densities.ana: LDens_InvertedWishart, LDens_Wishart

Power law distribution library.ana: PowerLawDist, CumPowerLawDist, CumPowerLawDistInv, DensPowerLawDist

User interaction and dialogs

{{Assista|key|List of built-in functions for user interaction.} User input: Choice, Checkbox, MultiChoice, Choices & Checkboxes in an Edit table

Dialog Functions: MsgBox, Error, AskMsgText, AskMsgChoice, AskMsgNumber, ShowProgressBar

Controlling the interface: ChangeNodeVisibility, CloseWindow, ShowWindow

Debugging: ConsolePrint

Drawing functions: Canvas, CanvasContext, CanvasDrawEllipse, CanvasDrawImage, CanvasDrawLine, CanvasDrawPixel, CanvasDrawPolygon, CanvasDrawRectangle, CanvasDrawText, CanvasImage, GraphToCanvasCoord, ImageInfo.

Cell-level format functions: CellAlignment, CellBar, CellBorder, CellComparisonFormat, CellEntry, CellFill, CellFont, CellFormats, CellIcon, CellNumberFormat, CellOnClick, CellSpan

Graph annotations: In OnGraphDraw annotations.ana: Plot_error_bars, Plot_Tukey_bars, Plot_point_labels, Plot_solid_band, Plot_solid_prob_band, Clip_to_PlotArea, Apply_slicers_to_val. In Google Maps from OnGraphDraw.ana: OnDraw_Google_map, Test_map_pivot_vars, Test_map_pivot_slice.

Types and type conversion

Convert type: Chr, Asc, NumberToText, ParseDate, ParseNumber

Data Type Functions: TypeOf, IsDateTime, IsHandle, IsNaN, IsNull, IsNumber, IsRealNumber, IsReference, IsText, IsUndef, IsResultComputed, IsNotSpecified, ComparisonPart

Optimizer functions

Optimizer formulation: DefineOptimization, OptSolution, OptInfo, OptObjective, GroupedInteger, OptGuess, OptEngineInfo

Optimizer diagnostics: OptStatusNum, OptStatusText, OptFindIIS, OptWriteIIS, OptObjectiveSa, OptRead, OptWrite, OptReducedCost, OptRhsSa, OptScalarToConstraint, OptScalarToDecision, OptShadow, OptSlack

Integration with other applications

Reading and writing data: ReadFromUrl, OpenURL, ReadImageFile, WriteImageFile, ReadTextFile, WriteTextFile, ReadBinaryFile, WriteBinaryFile, ReadExportFile, ShowPdfFile

Spreadsheet access: SpreadsheetOpen, SpreadsheetCell, SpreadsheetRange, SpreadsheetSetCell, SpreadsheetSetRange,SpreadsheetSave, SpreadsheetInfo, SpreadsheetSetInfo

Database and ODBC access: SqlDriverInfo, DbLabels, DbQuery, DbTable, DbTablenames, DbWrite, MdxQuery

Run other applications: RunConsoleProcess

COM Integration: COMArray, COMCallMethod, COMCreateObject, COMGetProperty, COMPutProperty, COMEnumerate

File System Functions: CurrentDataFolder, CurrentModelFolder, FileFullPath, FilePathPart, FileSystemCopy, FileSystemDelete, FileSystemListing, FileSystemMove, FileSystemNewFolder.

Parsing and formatting data: ParseCSV, MakeCSV, ParseJSON, MakeJSON, ParseNumber, ParseDate, NumberToText, f"...". See also XML.

Special functions

Meta-inference: Handle, HandleFromIdentifier, ListOfHandles, FindObjects, Dereference Operator: #R IndexesOf, IndexNames, GetVariableByName, IndexValue, AttribGet, InvalidateResult

Evaluation: Mid, Sample, Evaluate, EvaluateScript, GetEvaluationContext

Error handling: Error, IgnoreWarnings, Try, ReThrow, Error Message Types

Miscellaneous: Discrete, Dispatch, FunctionOf, Dynamic, Iterate, FindPolynomialZeroes

Domain Expressions: ContinuousDiscreteIntegerBoolean and Discrete

Domain Access Functions: DomainType, DomainType, DomainLowerBound, DomainUpperBound, DomainIntegerGroup

Attributes

Editable attributes for variables: Class, Identifier, Title, Units, Description, Definition, Check, Domain, MetaIndex, User-defined attributes

User editable for Functions: Parameters, Recursive

User editable for Models, Modules, and Libraries: Author, Savedate, Filename

Computed attributes: Value, Probvalue, Inputs, Outputs

Internal: Diagwindow, ObjectWindow.

Classes of Object

Decision, Chance, Objective, Variable, Moduke, Index, Constant, Function, Button, Text node, Constrain, Gradient, User input, User output, Frame node, Module, Model, Linked module, Library, Linked Library, Form

System variables

Common: Run, SampleSize, Time

System info: AnalyticaLicenseInfo, GetProcessInfo, GetRegistryValue, MemoryInUseBy

Function parameter qualifiers

Data types: Number, Text, Positive, NonNegative, Ascending, Descending, Reference, Handle, Coerce <type>

Object class: Index, Variable, Object

Optional and repeated parameters: Optional, Default, Repeated parameters (...)

Arrays: Atom or scalar, Vector, Array, Reduced

Libraries

Standard libraries, Additional libraries, GCD function library.ana: GCD

Optimization Functions.ana: GoalSeek, Gradient

Financial library.ana: Implied_volatility_c, Implied_volatility_p

ODBC Library.ana: InsertRecSql,

Generalized Regression.ana: InvLogit, Logistic_Regression, Logit

Linked List Library.ana: LL_First, LL_Length, LL_Nth, LL_Push, LL_Remove_First, LL_To_Array, LL_to_RArray

Comments


You are not allowed to post comments.