Merge pull request #21 from zrho/master

Indexed optics.

Author: paf31

bower.json

@@ -23,6 +23,7 @@
     "purescript-profunctor": "~0.3.0",
     "purescript-sets": "~0.5.1",
     "purescript-unsafe-coerce": "~0.1.0",
-    "purescript-transformers": "~0.8.1"
+    "purescript-transformers": "~0.8.1",
+    "purescript-functor-compose": "~0.0.1"
   }
 }

docs/Data/Lens/Fold.md

@@ -223,4 +223,60 @@ replicated :: forall a b t f. (Applicative f, Contravariant f) => Int -> Optic (
 
 Replicates the elements of a fold.
 
+#### `ifoldMapOf`
+
+``` purescript
+ifoldMapOf :: forall r i s t a b. IndexedFold r i s t a b -> (i -> a -> r) -> s -> r
+```
+
+Fold map over an `IndexedFold`.
+
+#### `ifoldrOf`
+
+``` purescript
+ifoldrOf :: forall i s t a b r. IndexedFold (Endo r) i s t a b -> (i -> a -> r -> r) -> r -> s -> r
+```
+
+Right fold over an `IndexedFold`.
+
+#### `ifoldlOf`
+
+``` purescript
+ifoldlOf :: forall i s t a b r. IndexedFold (Dual (Endo r)) i s t a b -> (i -> r -> a -> r) -> r -> s -> r
+```
+
+Left fold over an `IndexedFold`.
+
+#### `iallOf`
+
+``` purescript
+iallOf :: forall i s t a b r. (BooleanAlgebra r) => IndexedFold (Conj r) i s t a b -> (i -> a -> r) -> s -> r
+```
+
+Whether all foci of an `IndexedFold` satisfy a predicate.
+
+#### `ianyOf`
+
+``` purescript
+ianyOf :: forall i s t a b r. (BooleanAlgebra r) => IndexedFold (Disj r) i s t a b -> (i -> a -> r) -> s -> r
+```
+
+Whether any focus of an `IndexedFold` satisfies a predicate.
+
+#### `itoListOf`
+
+``` purescript
+itoListOf :: forall i s t a b. IndexedFold (Endo (List (Tuple i a))) i s t a b -> s -> List (Tuple i a)
+```
+
+Collects the foci of an `IndexedFold` into a list.
+
+#### `itraverseOf_`
+
+``` purescript
+itraverseOf_ :: forall i f s t a b r. (Applicative f) => IndexedFold (Endo (f Unit)) i s t a b -> (i -> a -> f r) -> s -> f Unit
+```
+
+Traverse the foci of an `IndexedFold`, discarding the results.
+
 

docs/Data/Lens/Getter.md

@@ -10,6 +10,14 @@ view :: forall s t a b. Getter s t a b -> s -> a
 
 View the focus of a `Getter`.
 
+#### `iview`
+
+``` purescript
+iview :: forall i s t a b. IndexedFold (Tuple i a) i s t a b -> s -> Tuple i a
+```
+
+View the focus of a `Getter` and its index.
+
 #### `(^.)`
 
 ``` purescript
@@ -28,4 +36,20 @@ to :: forall s a f. (Contravariant f) => (s -> a) -> Optic (Star f) s s a a
 
 Convert a function into a getter.
 
+#### `use`
+
+``` purescript
+use :: forall s t a b m. (MonadState s m) => Getter s t a b -> m a
+```
+
+View the focus of a `Getter` in the state of a monad.
+
+#### `iuse`
+
+``` purescript
+iuse :: forall i s t a b m. (MonadState s m) => IndexedFold (Tuple i a) i s t a b -> m (Tuple i a)
+```
+
+View the focus of a `Getter` and its index in the state of a monad.
+
 

docs/Data/Lens/Indexed.md

@@ -0,0 +1,27 @@
+## Module Data.Lens.Indexed
+
+#### `unIndex`
+
+``` purescript
+unIndex :: forall p i s t a b. (Profunctor p) => IndexedOptic p i s t a b -> Optic p s t a b
+```
+
+Converts an `IndexedOptic` to an `Optic` by forgetting indices.
+
+#### `iwander`
+
+``` purescript
+iwander :: forall p i s t a b. (Wander p) => (forall f. (Applicative f) => (i -> a -> f b) -> s -> f t) -> Indexed p i a b -> p s t
+```
+
+Converts a `lens`-like indexed traversal to an `IndexedTraversal`.
+
+#### `positions`
+
+``` purescript
+positions :: forall p s t a b. (Wander p) => Traversal s t a b -> IndexedOptic p Int s t a b
+```
+
+Converts a `Traversal` to an `IndexedTraversal` by using the integer positions as indices.
+
+

docs/Data/Lens/Internal/Focusing.md

@@ -0,0 +1,27 @@
+## Module Data.Lens.Internal.Focusing
+
+This module defines the `Focusing` functor
+
+#### `Focusing`
+
+``` purescript
+newtype Focusing m s a
+  = Focusing (m (Tuple s a))
+```
+
+The functor used to zoom into `StateT`.
+
+##### Instances
+``` purescript
+instance focusingFunctor :: (Functor m) => Functor (Focusing m s)
+instance focusingApply :: (Apply m, Semigroup s) => Apply (Focusing m s)
+instance focusingApplicative :: (Applicative m, Monoid s) => Applicative (Focusing m s)
+```
+
+#### `runFocusing`
+
+``` purescript
+runFocusing :: forall m s a. Focusing m s a -> m (Tuple s a)
+```
+
+

docs/Data/Lens/Internal/Forget.md

@@ -0,0 +1,33 @@
+## Module Data.Lens.Internal.Forget
+
+#### `Forget`
+
+``` purescript
+newtype Forget r a b
+  = Forget (a -> r)
+```
+
+Profunctor that forgets the `b` value and returns (and accumulates) a
+value of type `r`.
+
+`Forget r` is isomorphic to `Star (Const r)`, but can be given a `Cochoice`
+instance.
+
+##### Instances
+``` purescript
+instance profunctorForget :: Profunctor (Forget r)
+instance choiceForget :: (Monoid r) => Choice (Forget r)
+instance strongForget :: Strong (Forget r)
+instance cochoiceForget :: Cochoice (Forget r)
+instance wanderForget :: (Monoid r) => Wander (Forget r)
+```
+
+#### `runForget`
+
+``` purescript
+runForget :: forall r a b. Forget r a b -> a -> r
+```
+
+Unwrap a value of type `Forget`.
+
+

docs/Data/Lens/Internal/Indexed.md

@@ -0,0 +1,29 @@
+## Module Data.Lens.Internal.Indexed
+
+This module defines the `Indexed` profunctor.
+
+#### `Indexed`
+
+``` purescript
+newtype Indexed p i s t
+  = Indexed (p (Tuple i s) t)
+```
+
+Profunctor used for `IndexedOptic`s.
+
+##### Instances
+``` purescript
+instance indexedProfunctor :: (Profunctor p) => Profunctor (Indexed p i)
+instance indexedStrong :: (Strong p) => Strong (Indexed p i)
+instance indexedChoice :: (Choice p) => Choice (Indexed p i)
+```
+
+#### `fromIndexed`
+
+``` purescript
+fromIndexed :: forall p i s t. Indexed p i s t -> p (Tuple i s) t
+```
+
+Unwrap a value of type `Indexed`.
+
+

docs/Data/Lens/Internal/Re.md

@@ -0,0 +1,27 @@
+## Module Data.Lens.Internal.Re
+
+This module defines the `Re` profunctor
+
+#### `Re`
+
+``` purescript
+newtype Re p s t a b
+  = Re (p b a -> p t s)
+```
+
+##### Instances
+``` purescript
+instance profunctorRe :: (Profunctor p) => Profunctor (Re p s t)
+instance choiceRe :: (Choice p) => Cochoice (Re p s t)
+instance cochoiceRe :: (Cochoice p) => Choice (Re p s t)
+instance strongRe :: (Strong p) => Costrong (Re p s t)
+instance costrongRe :: (Costrong p) => Strong (Re p s t)
+```
+
+#### `runRe`
+
+``` purescript
+runRe :: forall p s t a b. Re p s t a b -> p b a -> p t s
+```
+
+

docs/Data/Lens/Internal/Tagged.md

@@ -13,6 +13,7 @@ newtype Tagged a b
 ``` purescript
 instance taggedProfunctor :: Profunctor Tagged
 instance taggedChoice :: Choice Tagged
+instance taggedCostrong :: Costrong Tagged
 ```
 
 #### `unTagged`

docs/Data/Lens/Iso.md

@@ -26,6 +26,14 @@ cloneIso :: forall s t a b. AnIso s t a b -> Iso s t a b
 
 Extracts an `Iso` from `AnIso`.
 
+#### `re`
+
+``` purescript
+re :: forall p s t a b. Optic (Re p a b) s t a b -> Optic p b a t s
+```
+
+Reverses an optic.
+
 #### `au`
 
 ``` purescript