public class AstTopN extends AstPrimitive
Modifier and Type | Class and Description |
---|---|
class |
AstTopN.GrabTopNPQ<E extends java.lang.Comparable<E>> |
class |
AstTopN.RowValue<E extends java.lang.Comparable<E>> |
Constructor and Description |
---|
AstTopN() |
Modifier and Type | Method and Description |
---|---|
ValFrame |
apply(Env env,
Env.StackHelp stk,
AstRoot[] asts)
Primary method to invoke this function, passing all the parameters
as the `asts` list.
|
java.lang.String[] |
args()
List of argument names.
|
java.lang.String |
description()
Return the detailed description (help) for what this language construct
does or how it is supposed to be used.
|
java.lang.String |
example()
Return an example of how this Ast construct ought to be used.
|
int |
nargs()
Number of function's arguments + 1.
|
java.lang.String |
str()
String representation of this Ast object in the Rapids language.
|
exec
asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonString, write, writeExternal, writeJSON
public java.lang.String[] args()
AstPrimitive
args
in class AstPrimitive
public java.lang.String str()
AstRoot
AstPrimitive
s this is the name of the function; for
AstParameter
s this is either the name of the variable, or the
value of the numeric constant that the parameter represents. For more
complicated constructs such as AstExec
or AstFunction
this method should return those objects as a Rapids string.public int nargs()
AstPrimitive
nargs
in class AstPrimitive
public java.lang.String example()
AstRoot
Return an example of how this Ast construct ought to be used. This
method is used to build documentation for the Rapids language. It is
different from AstRoot.str()
, in particular it must provide a valid
example even in a static context. For example, an AstStr
may
return "Hello, world!"
as an example. At the same time,
for different AstPrimitive
s this method should generally provide
a typical example of how that function is to be used.
Return null
to indicate that the object should not be
included in the documentation.
example
in class AstPrimitive
public java.lang.String description()
AstRoot
Return the detailed description (help) for what this language construct
does or how it is supposed to be used. This method is used in conjunction
with AstRoot.example()
to build the documentation of the Rapids
language.
If you need to include any formatting, then please use Markup language. Although it is up to the client to support it, Markup is one of the simplest and easiest alternatives.
Return null
to indicate that the object should not be
included in the documentation.
description
in class AstPrimitive
public ValFrame apply(Env env, Env.StackHelp stk, AstRoot[] asts)
AstPrimitive
Primary method to invoke this function, passing all the parameters as the `asts` list.
apply
in class AstPrimitive
env
- Current execution environment. Variables are looked up here.stk
- TODO need clarificationasts
- List of AstRoot expressions that are arguments to the
function. First element in this list is the function itself.