-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | This package provides functions for relocate an item within a list.
--   
--   Please see the README on GitHub at
--   <a>https://github.com/fesanmar/scroll-list#readme</a>
@package scroll-list
@version 1.1.0.0


-- | This module provides functions for relocate an item within a list.
module Data.List.Scroll

-- | The <a>up</a> function moves an element <tt>n</tt> positions to the
--   beginning of a list. If the index provided is out of range, the list
--   is returned without any modification. On the other hand, extra steps
--   will be ignored.
--   
--   Some examples are given below:
--   
--   <pre>
--   &gt;&gt;&gt; up 2 2 ["one", "two", "three"]
--   ["three", "one", "two"]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; up 4 1 ["one", "two", "three"]
--   ["one", "two", "three"]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; up 2 3 ["one", "two", "three"]
--   ["three", "one", "two"]
--   </pre>
up :: Int -> Int -> [a] -> [a]

-- | The <a>down</a> function moves an element <tt>n</tt> positions to the
--   end of a list. If the index provided is out of range, the list is
--   returned without any modification. On the other hand, extra steps will
--   be ignored.
--   
--   Some examples are given below:
--   
--   <pre>
--   &gt;&gt;&gt; down 0 1 ["one", "two", "three"]
--   ["two", "one", "three"]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; down 4 1 ["one", "two", "three"]
--   ["one", "two", "three"]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; down 0 4 ["one", "two", "three"]
--   ["two", "three", "one"]
--   </pre>
down :: Int -> Int -> [a] -> [a]

-- | The <a>deleteByIndex</a> function removes an element from a list by
--   its position within it. For example,
--   
--   <pre>
--   &gt;&gt;&gt; deleteByIndex 1 ["one", "two", "three"]
--   ["one", "three"]
--   </pre>
--   
--   If index is out of range, the list will be returned with no changes.
--   For example:
--   
--   <pre>
--   &gt;&gt;&gt; deleteByIndex 3 ["one", "two", "three"]
--   ["one", "two", "three"]
--   </pre>
deleteByIndex :: Int -> [a] -> [a]