Liking cljdoc? Tell your friends :D

cascalog.logic.vars

This namespace deals with all Cascalog variable transformations.

This namespace deals with all Cascalog variable
transformations.
raw docstring

cascalog-var?clj

(cascalog-var? obj)

A predicate on 'obj' to check is it a cascalog variable.

A predicate on 'obj' to check is it a cascalog variable.
raw docstring

fully-ground?clj

Returns true if every supplied var is a ground variable, false otherwise.

Returns true if every supplied var is a ground variable, false
otherwise.
raw docstring

gen-non-nullable-varclj

Returns a unique non-nullable var with a optional suffix.

Returns a unique non-nullable var with a optional suffix.
raw docstring

gen-non-nullable-varsclj

(gen-non-nullable-vars amt)

Generates the given number, 'amt', of non-nullable variables in a sequence.

Example: (let [var-seq (gen-non-nullable-vars n)] (?<- (hfs-textline out-path) var-seq (in :>> var-seq)))

Generates the given number, 'amt', of non-nullable variables in a sequence.

Example:
(let [var-seq (gen-non-nullable-vars n)]
  (?<- (hfs-textline out-path)
       var-seq
       (in :>> var-seq)))
raw docstring

gen-nullable-varclj

Returns a unique nullable var with a optional suffix.

Returns a unique nullable var with a optional suffix.
raw docstring

gen-nullable-varsclj

(gen-nullable-vars amt)

Generates the given number, 'amt', of nullable variables in a sequence.

Example: (let [var-seq (gen-nullable-vars n)] (?<- (hfs-textline out-path) var-seq (in :>> var-seq)))

Generates the given number, 'amt', of nullable variables in a sequence.

Example:
(let [var-seq (gen-nullable-vars n)]
  (?<- (hfs-textline out-path)
       var-seq
       (in :>> var-seq)))
raw docstring

gen-ungrounding-varclj

Returns a unique ungrounding var with an optional suffix.

Returns a unique ungrounding var with an optional suffix.
raw docstring

gen-var-fnclj

(gen-var-fn prefix)

Accepts a prefix and returns a function of no arguments that, when called, produces a unique string with the supplied prefix.

Accepts a prefix and returns a function of no arguments that, when
called, produces a unique string with the supplied prefix.
raw docstring

ground-var?clj

Returns true of the supplied var is capable of triggering a join (prefixed by ! or ?), false otherwise.

Returns true of the supplied var is capable of triggering a join
(prefixed by ! or ?), false otherwise.
raw docstring

logic-prefixesclj

Symbol prefixes reserved by Cascalog for use within predicates. Any symbol or string prefixed by one of these characters will be interpreted as a logic variable.

Symbol prefixes reserved by Cascalog for use within predicates. Any
symbol or string prefixed by one of these characters will be
interpreted as a logic variable.
raw docstring

logic-sym?clj

Returns true if the supplied symbol is a Cascalog logic variable, false otherwise. & and _ are also accepted.

Returns true if the supplied symbol is a Cascalog logic variable,
false otherwise. & and _ are also accepted.
raw docstring

non-nullable-var?clj

(non-nullable-var? sym-or-str)

Returns true if the supplied symbol (or string) references a non-nullable logic variable (prefixed by ?), false otherwise.

Returns true if the supplied symbol (or string) references a
non-nullable logic variable (prefixed by ?), false otherwise.
raw docstring

nullable-var?clj

Returns true of the supplied symbol (or string) references a nullable logic variable (prefixed by ! or !!)

Returns true of the supplied symbol (or string) references a
nullable logic variable (prefixed by ! or !!)
raw docstring

prefixed-by?clj

(prefixed-by? prefix v)

Returns true if the supplied var v is prefixed by the supplied prefix, false otherwise.

Returns true if the supplied var `v` is prefixed by the supplied
prefix, false otherwise.
raw docstring

replace-dupsclj

(replace-dups coll)

Accepts a sequence returns the set of replacements, plus a new sequence with all duplicates replaced by a call to gen.

Accepts a sequence returns the set of replacements, plus a new
sequence with all duplicates replaced by a call to `gen`.
raw docstring

reserved?clj

Returns true if the supplied symbol is reserved by Cascalog, false otherwise.

Returns true if the supplied symbol is reserved by Cascalog, false
otherwise.
raw docstring

sanitizeclj

(sanitize pred)

Accepts a (potentially nested) data structure and returns a transformed, sanitized predicate generated by replacing all wildcards and logic variables with strings.

Accepts a (potentially nested) data structure and returns a
transformed, sanitized predicate generated by replacing all
wildcards and logic variables with strings.
raw docstring

sanitize-fnclj

(sanitize-fn anon-gen)

Returns a function that sanitizes an element by resolving logic variable names and replacing wildcards using the supplied generator.

Returns a function that sanitizes an element by resolving logic
variable names and replacing wildcards using the supplied
generator.
raw docstring

selector?clj

Returns true if the supplied keyword is reserved by cascalog, false otherwise.

Returns true if the supplied keyword is reserved by cascalog, false
otherwise.
raw docstring

selectorsclj

Keywords that have special meaning within Cascalog's predicates.

Keywords that have special meaning within Cascalog's predicates.
raw docstring

unground-var?clj

(unground-var? sym-or-str)

Returns true if the supplied symbol (or string) references an ungrounding logic variable (prefixed by !!), false otherwise.

Returns true if the supplied symbol (or string) references an
ungrounding logic variable (prefixed by !!), false otherwise.
raw docstring

uniquify-varclj

(uniquify-var v)

Appends a unique suffix to the supplied input.

Appends a unique suffix to the supplied input.
raw docstring

wildcardsclj

Wildcard strings reserved by Cascalog.

Wildcard strings reserved by Cascalog.
raw docstring

with-logic-varscljmacro

(with-logic-vars to-search & body)

Binds all logic variables within the to-search of with-logic-vars to their string equivalents, allowing the user to write bare symbols within the body.

For example:

(with-logic-vars [?a ?b :see] (str ?a ?b :see)) ;=> "?a?b:see"

Binds all logic variables within the `to-search` of `with-logic-vars` to
 their string equivalents, allowing the user to write bare symbols within the body.

For example:

 (with-logic-vars [?a ?b :see]
   (str ?a ?b :see))
 ;=>  "?a?b:see"
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close