Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell98 |
Data.List.PointedList.Circular
Synopsis
- data PointedList a = PointedList {
- _reversedPrefix :: [a]
- _focus :: a
- _suffix :: [a]
- index :: PointedList a -> Int
- length :: PointedList a -> Int
- fromList :: [a] -> Maybe (PointedList a)
- find :: Eq a => a -> PointedList a -> Maybe (PointedList a)
- insert :: a -> PointedList a -> PointedList a
- singleton :: a -> PointedList a
- focus :: Functor f => (a -> f a) -> PointedList a -> f (PointedList a)
- fromListEnd :: [a] -> Maybe (PointedList a)
- replace :: a -> PointedList a -> PointedList a
- insertLeft :: a -> PointedList a -> PointedList a
- insertRight :: a -> PointedList a -> PointedList a
- deleteOthers :: PointedList a -> PointedList a
- positions :: PointedList a -> PointedList (PointedList a)
- contextMap :: (PointedList a -> b) -> PointedList a -> PointedList b
- withFocus :: PointedList a -> PointedList (a, Bool)
- next :: PointedList a -> PointedList a
- previous :: PointedList a -> PointedList a
- delete :: PointedList a -> Maybe (PointedList a)
- deleteLeft :: PointedList a -> Maybe (PointedList a)
- deleteRight :: PointedList a -> Maybe (PointedList a)
- moveN :: Int -> PointedList a -> PointedList a
Documentation
data PointedList a Source #
The implementation of the pointed list structure which tracks the current position in the list structure.
Constructors
PointedList | |
Fields
|
Instances
index :: PointedList a -> Int Source #
The index of the focus, leftmost is 0.
length :: PointedList a -> Int Source #
The length of the list.
fromList :: [a] -> Maybe (PointedList a) Source #
Possibly create a
if the provided list has at least
one element; otherwise, return Nothing.Just
PointedList
The provided list's head will be the focus of the list, and the rest of list will follow on the right side.
find :: Eq a => a -> PointedList a -> Maybe (PointedList a) Source #
Move the focus to the specified element, if it is present.
Patch with much faster algorithm provided by Runar Bjarnason for version 0.3.2. Improved again by Runar Bjarnason for version 0.3.3 to support infinite lists on both sides of the focus.
insert :: a -> PointedList a -> PointedList a Source #
An alias for insertRight
.
singleton :: a -> PointedList a Source #
Create a PointedList
with a single element.
focus :: Functor f => (a -> f a) -> PointedList a -> f (PointedList a) Source #
Lens compatible with Control.Lens.
fromListEnd :: [a] -> Maybe (PointedList a) Source #
Possibly create a
if the provided list has at least
one element; otherwise, return Nothing.Just
PointedList
The provided list's last element will be the focus of the list, following the rest of the list in order, to the left.
replace :: a -> PointedList a -> PointedList a Source #
Replace the focus of the list, retaining the prefix and suffix.
insertLeft :: a -> PointedList a -> PointedList a Source #
Insert an element to the left of the focus, then move the focus to the new element.
insertRight :: a -> PointedList a -> PointedList a Source #
Insert an element to the right of the focus, then move the focus to the new element.
deleteOthers :: PointedList a -> PointedList a Source #
Delete all elements in the list except the focus.
positions :: PointedList a -> PointedList (PointedList a) Source #
Create a PointedList
of variations of the provided PointedList
, in
which each element is focused, with the provided PointedList
as the
focus of the sets.
contextMap :: (PointedList a -> b) -> PointedList a -> PointedList b Source #
Map over the PointedList
s created via positions
, such that f
is
called with each element of the list focused in the provided
PointedList
. An example makes this easier to understand:
contextMap atStart (fromJust $ fromList [1..5])
withFocus :: PointedList a -> PointedList (a, Bool) Source #
Create a
of PointedList
a(a,
, in which the boolean values
specify whether the current element has the focus. That is, all of the
booleans will be Bool
)False
, except the focused element.
next :: PointedList a -> PointedList a Source #
Move the focus to the next element in the list. If the last element is currently focused, loop to the first element.
previous :: PointedList a -> PointedList a Source #
Move the focus to the previous element in the list. If the first element is currently focused, loop to the last element.
delete :: PointedList a -> Maybe (PointedList a) Source #
An alias of deleteRight
.
deleteLeft :: PointedList a -> Maybe (PointedList a) Source #
Possibly delete the element at the focus, then move the element on the
left to the focus. If no element is on the left, focus on the element to
the right. If the deletion will cause the list to be empty, return
Nothing
.
deleteRight :: PointedList a -> Maybe (PointedList a) Source #
Possibly delete the element at the focus, then move the element on the
right to the focus. If no element is on the right, focus on the element to
the left. If the deletion will cause the list to be empty, return
Nothing
.
moveN :: Int -> PointedList a -> PointedList a Source #
Move