From 3c58ef4e145a62fa03ba7e88784fbe8e8e05f330 Mon Sep 17 00:00:00 2001 From: Nathan Marz Date: Thu, 2 Jun 2016 12:18:11 -0400 Subject: [PATCH] fix source links --- com.rpl.specter.html | 80 ++++++++++++++++++------------------- com.rpl.specter.macros.html | 14 +++---- com.rpl.specter.zipper.html | 20 +++++----- 3 files changed, 57 insertions(+), 57 deletions(-) diff --git a/com.rpl.specter.html b/com.rpl.specter.html index c994db1..fa6bea7 100644 --- a/com.rpl.specter.html +++ b/com.rpl.specter.html @@ -1,16 +1,16 @@ -com.rpl.specter documentation

Project

Namespaces

Public Vars

com.rpl.specter

ATOM
Navigates to atom value.
-
view source
BEGINNING
view source
bind-params*
Takes a compiled path that needs late-bound params and supplies it with
+com.rpl.specter documentation
Project
Namespaces
Public Vars
com.rpl.specter
ATOM
Navigates to atom value.
+
view source
BEGINNING
view source
bind-params*
Takes a compiled path that needs late-bound params and supplies it with
 an array of params and a position in the array from which to begin reading
-params. The return value is an executable selector.
view source
codewalker
view source
collect-one
view source
comp-paths
(comp-paths & paths)
view source
compiled-replace-in
Version of replace-in that takes in a path precompiled with comp-paths
-
view source
compiled-select
Version of select that takes in a path pre-compiled with comp-paths
-
view source
compiled-select-first
Version of select-first that takes in a path pre-compiled with comp-paths
-
view source
compiled-select-one
Version of select-one that takes in a path pre-compiled with comp-paths
-
view source
compiled-select-one!
Version of select-one! that takes in a path pre-compiled with comp-paths
-
view source
compiled-setval
Version of setval that takes in a path precompiled with comp-paths
-
view source
compiled-transform
Version of transform that takes in a path pre-compiled with comp-paths
-
view source
cond-path
Takes in alternating cond-path path cond-path path...
+params. The return value is an executable selector.
view source
codewalker
view source
collect-one
view source
comp-paths
(comp-paths & paths)
view source
compiled-replace-in
Version of replace-in that takes in a path precompiled with comp-paths
+
view source
compiled-select
Version of select that takes in a path pre-compiled with comp-paths
+
view source
compiled-select-first
Version of select-first that takes in a path pre-compiled with comp-paths
+
view source
compiled-select-one
Version of select-one that takes in a path pre-compiled with comp-paths
+
view source
compiled-select-one!
Version of select-one! that takes in a path pre-compiled with comp-paths
+
view source
compiled-setval
Version of setval that takes in a path precompiled with comp-paths
+
view source
compiled-transform
Version of transform that takes in a path pre-compiled with comp-paths
+
view source
cond-path
Takes in alternating cond-path path cond-path path...
 Tests the structure if selecting with cond-path returns anything.
 If so, it uses the following path for this portion of the navigation.
 Otherwise, it tries the next cond-path. If nothing matches, then the structure
@@ -18,19 +18,19 @@ is not selected.
 
 The input paths may be parameterized, in which case the result of cond-path
 will be parameterized in the order of which the parameterized navigators
-were declared.
view source
continue-then-stay
Navigates to the provided path and then to the current element. This can be used
-to implement post-order traversal.
view source
continuous-subseqs
Navigates to every continuous subsequence of elements matching `pred`
-
view source
filterer
Navigates to a view of the current sequence that only contains elements that
+were declared.
view source
continue-then-stay
Navigates to the provided path and then to the current element. This can be used
+to implement post-order traversal.
view source
continuous-subseqs
Navigates to every continuous subsequence of elements matching `pred`
+
view source
filterer
Navigates to a view of the current sequence that only contains elements that
 match the given path. An element matches the selector path if calling select
 on that element with the path yields anything other than an empty sequence.
 
  The input path may be parameterized, in which case the result of filterer
  will be parameterized in the order of which the parameterized selectors
- were declared.
view source
if-path
Like cond-path, but with if semantics.
-
view source
keypath
Navigates to the specified key, navigating to nil if it does not exist.
-
view source
multi-path
A path that branches on multiple paths. For updates,
-applies updates to the paths in order.
view source
must
Navigates to the key only if it exists in the map.
-
view source
must-cache-paths!
Mandate that operations that do inline path factoring and compilation
+ were declared.
view source
if-path
Like cond-path, but with if semantics.
+
view source
keypath
Navigates to the specified key, navigating to nil if it does not exist.
+
view source
multi-path
A path that branches on multiple paths. For updates,
+applies updates to the paths in order.
view source
must
Navigates to the key only if it exists in the map.
+
view source
must-cache-paths!
Mandate that operations that do inline path factoring and compilation
 (select/transform/setval/replace-in/path/etc.) must succeed in 
 factoring the path into static and dynamic portions. If not, an
 error will be thrown and the reasons for not being able to factor
@@ -39,47 +39,47 @@ can be used to turn this feature off.
 
 Reasons why it may not be able to factor a path include using
 a local symbol, special form, or regular function invocation
-where a navigator is expected.
view source
NIL->LIST
view source
NIL->SET
view source
nil->val
Navigates to the provided val if the structure is nil. Otherwise it stays
-navigated at the structure.
view source
NIL->VECTOR
view source
not-selected?
view source
params-reset
(params-reset params-path)
view source
pred
Keeps the element only if it matches the supplied predicate. This is the
-late-bound parameterized version of using a function directly in a path.
view source
putval
Adds an external value to the collected vals. Useful when additional arguments
+where a navigator is expected.
view source
NIL->LIST
view source
NIL->SET
view source
nil->val
Navigates to the provided val if the structure is nil. Otherwise it stays
+navigated at the structure.
view source
NIL->VECTOR
view source
not-selected?
view source
params-reset
(params-reset params-path)
view source
pred
Keeps the element only if it matches the supplied predicate. This is the
+late-bound parameterized version of using a function directly in a path.
view source
putval
Adds an external value to the collected vals. Useful when additional arguments
 are required to the transform function that would otherwise require partial
 application or a wrapper function.
 
 e.g., incrementing val at path [:a :b] by 3:
-(transform [:a :b (putval 3)] + some-map)
view source
replace-in*
(replace-in* path transform-fn structure & {:keys [merge-fn], :or {merge-fn concat}})
Similar to transform, except returns a pair of [transformed-structure sequence-of-user-ret].
+(transform [:a :b (putval 3)] + some-map)
view source
replace-in*
(replace-in* path transform-fn structure & {:keys [merge-fn], :or {merge-fn concat}})
Similar to transform, except returns a pair of [transformed-structure sequence-of-user-ret].
 The transform-fn in this case is expected to return [ret user-ret]. ret is
 what's used to transform the data structure, while user-ret will be added to the user-ret sequence
 in the final return. replace-in is useful for situations where you need to know the specific values
-of what was transformed in the data structure.
view source
select*
(select* path structure)
Navigates to and returns a sequence of all the elements specified by the path.
-
view source
select-first*
(select-first* path structure)
Returns first element found. Not any more efficient than select, just a convenience
-
view source
select-one!*
(select-one!* path structure)
Returns exactly one element, throws exception if zero or multiple elements found
-
view source
select-one*
(select-one* path structure)
Like select, but returns either one element or nil. Throws exception if multiple elements found
-
view source
selected?
Filters the current value based on whether a path finds anything.
+of what was transformed in the data structure.
view source
select*
(select* path structure)
Navigates to and returns a sequence of all the elements specified by the path.
+
view source
select-first*
(select-first* path structure)
Returns first element found. Not any more efficient than select, just a convenience
+
view source
select-one!*
(select-one!* path structure)
Returns exactly one element, throws exception if zero or multiple elements found
+
view source
select-one*
(select-one* path structure)
Like select, but returns either one element or nil. Throws exception if multiple elements found
+
view source
selected?
Filters the current value based on whether a path finds anything.
 e.g. (selected? :vals ALL even?) keeps the current element only if an
 even number exists for the :vals key.
 
 The input path may be parameterized, in which case the result of selected?
 will be parameterized in the order of which the parameterized navigators
-were declared.
view source
setval*
(setval* path val structure)
Navigates to each value specified by the path and replaces it by val
-
view source
srange
Navigates to the subsequence bound by the indexes start (inclusive)
-and end (exclusive)
view source
srange-dynamic
Uses start-fn and end-fn to determine the bounds of the subsequence
-to select when navigating. Each function takes in the structure as input.
view source
STAY
Stays navigated at the current point. Essentially a no-op navigator.
-
view source
stay-then-continue
Navigates to the current element and then navigates via the provided path.
-This can be used to implement pre-order traversal.
view source
STOP
Stops navigation at this point. For selection returns nothing and for 
-transformation returns the structure unchanged
view source
submap
Navigates to the specified submap (using select-keys).
+were declared.
view source
setval*
(setval* path val structure)
Navigates to each value specified by the path and replaces it by val
+
view source
srange
Navigates to the subsequence bound by the indexes start (inclusive)
+and end (exclusive)
view source
srange-dynamic
Uses start-fn and end-fn to determine the bounds of the subsequence
+to select when navigating. Each function takes in the structure as input.
view source
STAY
Stays navigated at the current point. Essentially a no-op navigator.
+
view source
stay-then-continue
Navigates to the current element and then navigates via the provided path.
+This can be used to implement pre-order traversal.
view source
STOP
Stops navigation at this point. For selection returns nothing and for 
+transformation returns the structure unchanged
view source
submap
Navigates to the specified submap (using select-keys).
 In a transform, that submap in the original map is changed to the new
-value of the submap.
view source
subselect
Navigates to a sequence that contains the results of (select ...),
+value of the submap.
view source
subselect
Navigates to a sequence that contains the results of (select ...),
 but is a view to the original structure that can be transformed.
 
 Requires that the input navigators will walk the structure's
 children in the same order when executed on "select" and then
-"transform".
view source
subset
Navigates to the specified subset (by taking an intersection).
+"transform".
view source
subset
Navigates to the specified subset (by taking an intersection).
 In a transform, that subset in the original set is changed to the
-new value of the subset.
view source
transform*
(transform* path transform-fn structure)
Navigates to each value specified by the path and replaces it by the result of running
-the transform-fn on it
view source
transformed
Navigates to a view of the current value by transforming it with the
+new value of the subset.
view source
transform*
(transform* path transform-fn structure)
Navigates to each value specified by the path and replaces it by the result of running
+the transform-fn on it
view source
transformed
Navigates to a view of the current value by transforming it with the
 specified path and update-fn.
 
 The input path may be parameterized, in which case the result of transformed
 will be parameterized in the order of which the parameterized navigators
-were declared.
view source
view
Navigates to result of running `afn` on the currently navigated value.
-
view source

\ No newline at end of file
+were declared.
view source
view
Navigates to result of running `afn` on the currently navigated value.
+
view source

\ No newline at end of file
diff --git a/com.rpl.specter.macros.html b/com.rpl.specter.macros.html
index e8c5483..d62302a 100644
--- a/com.rpl.specter.macros.html
+++ b/com.rpl.specter.macros.html
@@ -1,22 +1,22 @@
 
-com.rpl.specter.macros documentation
Project
Namespaces
Public Vars
com.rpl.specter.macros
declarepath
macro
(declarepath name)(declarepath name params)
view source
defcollector
macro
(defcollector name & body)
view source
defnav
macro
(defnav name & body)
view source
defnavconstructor
macro
(defnavconstructor name & args)
view source
defpathedfn
macro
(defpathedfn name & args)
view source
defprotocolpath
macro
(defprotocolpath name)(defprotocolpath name params)
view source
extend-protocolpath
macro
(extend-protocolpath protpath & extensions)
view source
fixed-pathed-nav
macro
(fixed-pathed-nav bindings impl1 impl2)
This helper is used to define navigators that take in a fixed number of other
+com.rpl.specter.macros documentation
Project
Namespaces
Public Vars
com.rpl.specter.macros
declarepath
macro
(declarepath name)(declarepath name params)
view source
defcollector
macro
(defcollector name & body)
view source
defnav
macro
(defnav name & body)
view source
defnavconstructor
macro
(defnavconstructor name & args)
view source
defpathedfn
macro
(defpathedfn name & args)
view source
defprotocolpath
macro
(defprotocolpath name)(defprotocolpath name params)
view source
extend-protocolpath
macro
(extend-protocolpath protpath & extensions)
view source
fixed-pathed-nav
macro
(fixed-pathed-nav bindings impl1 impl2)
This helper is used to define navigators that take in a fixed number of other
 paths as input. Those paths may require late-bound params, so this helper
 will create a parameterized navigator if that is the case. If no late-bound params
-are required, then the result is executable.
view source
nav
macro
(nav params impl1 impl2)
Defines a navigator with late bound parameters. This navigator can be precompiled
+are required, then the result is executable.
view source
nav
macro
(nav params impl1 impl2)
Defines a navigator with late bound parameters. This navigator can be precompiled
 with other navigators without knowing the parameters. When precompiled with other
 navigators, the resulting path takes in parameters for all navigators in the path
-that needed parameters (in the order in which they were declared).
view source
paramscollector
macro
(paramscollector params impl)
Defines a Collector with late bound parameters. This collector can be precompiled
+that needed parameters (in the order in which they were declared).
view source
paramscollector
macro
(paramscollector params impl)
Defines a Collector with late bound parameters. This collector can be precompiled
 with other selectors without knowing the parameters. When precompiled with other
 selectors, the resulting selector takes in parameters for all selectors in the path
 that needed parameters (in the order in which they were declared).
- 
view source
paramsfn
macro
(paramsfn params [structure-sym] & impl)
view source
path
macro
(path & path)
Same as calling comp-paths, except it caches the composition of the static part
+ 
view source
paramsfn
macro
(paramsfn params [structure-sym] & impl)
view source
path
macro
(path & path)
Same as calling comp-paths, except it caches the composition of the static part
 of the path for later re-use (when possible). For almost all idiomatic uses
 of Specter provides huge speedup. This macro is automatically used by the
-select/transform/setval/replace-in/etc. macros.
view source
pathed-collector
macro
(pathed-collector [name path] impl)
This helper is used to define collectors that take in a single selector
+select/transform/setval/replace-in/etc. macros.
view source
pathed-collector
macro
(pathed-collector [name path] impl)
This helper is used to define collectors that take in a single selector
 paths as input. That path may require late-bound params, so this helper
 will create a parameterized selector if that is the case. If no late-bound params
-are required, then the result is executable.
view source
providepath
macro
(providepath name apath)
view source
replace-in
macro
(replace-in apath transform-fn structure & args)
view source
select
macro
(select apath structure)
view source
select-first
macro
(select-first apath structure)
view source
select-one
macro
(select-one apath structure)
view source
select-one!
macro
(select-one! apath structure)
view source
setval
macro
(setval apath aval structure)
view source
transform
macro
(transform apath transform-fn structure)
view source
variable-pathed-nav
macro
(variable-pathed-nav [latepaths-seq-sym paths-seq] impl1 impl2)
This helper is used to define navigators that take in a variable number of other
+are required, then the result is executable.
view source
providepath
macro
(providepath name apath)
view source
replace-in
macro
(replace-in apath transform-fn structure & args)
view source
select
macro
(select apath structure)
view source
select-first
macro
(select-first apath structure)
view source
select-one
macro
(select-one apath structure)
view source
select-one!
macro
(select-one! apath structure)
view source
setval
macro
(setval apath aval structure)
view source
transform
macro
(transform apath transform-fn structure)
view source
variable-pathed-nav
macro
(variable-pathed-nav [latepaths-seq-sym paths-seq] impl1 impl2)
This helper is used to define navigators that take in a variable number of other
 paths as input. Those paths may require late-bound params, so this helper
 will create a parameterized navigator if that is the case. If no late-bound params
-are required, then the result is executable.
view source

\ No newline at end of file
+are required, then the result is executable.
view source

\ No newline at end of file
diff --git a/com.rpl.specter.zipper.html b/com.rpl.specter.zipper.html
index 8b79d68..0d0347c 100644
--- a/com.rpl.specter.zipper.html
+++ b/com.rpl.specter.zipper.html
@@ -1,15 +1,15 @@
 
-com.rpl.specter.zipper documentation
Project
Namespaces
Public Vars
com.rpl.specter.zipper
find-first
Navigate the zipper to the first element
+com.rpl.specter.zipper documentation
Project
Namespaces
Public Vars
com.rpl.specter.zipper
find-first
Navigate the zipper to the first element
 in the structure matching predfn. A linear scan
-is done using NEXT to find the element.
view source
INNER-LEFT
Navigate to the empty subsequence directly to the
-left of this element.
view source
INNER-RIGHT
Navigate to the empty subsequence directly to the
-right of this element.
view source
LEFT
Navigate to the element to the left.
-If no element there, works like STOP.
view source
LEFTMOST
view source
NEXT
Navigate to the next element in the structure.
-If no next element, works like STOP.
view source
NEXT-WALK
Navigate to every element reachable using calls
-to NEXT
view source
NODE-SEQ
Navigate to the subsequence containing only
+is done using NEXT to find the element.
view source
INNER-LEFT
Navigate to the empty subsequence directly to the
+left of this element.
view source
INNER-RIGHT
Navigate to the empty subsequence directly to the
+right of this element.
view source
LEFT
Navigate to the element to the left.
+If no element there, works like STOP.
view source
LEFTMOST
view source
NEXT
Navigate to the next element in the structure.
+If no next element, works like STOP.
view source
NEXT-WALK
Navigate to every element reachable using calls
+to NEXT
view source
NODE-SEQ
Navigate to the subsequence containing only
 the node currently pointed to. This works just 
 like srange and can be used to remove elements
-from the structure
view source
PREV
Navigate to the previous element.
-If this is the first element, works like STOP.
view source
RIGHT
Navigate to the element to the right.
-If no element there, works like STOP.
view source
RIGHTMOST
view source
VECTOR-ZIP
view source

\ No newline at end of file
+from the structure
view source
PREV
Navigate to the previous element.
+If this is the first element, works like STOP.
view source
RIGHT
Navigate to the element to the right.
+If no element there, works like STOP.
view source
RIGHTMOST
view source
VECTOR-ZIP
view source

\ No newline at end of file