docs update

Author: Jutho

README.md

@@ -7,10 +7,10 @@
 [![Build Status](https://travis-ci.org/Jutho/TupleTools.jl.svg?branch=master)](https://travis-ci.org/Jutho/TupleTools.jl) [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md) [![Coverage Status](https://coveralls.io/repos/Jutho/TupleTools.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/Jutho/TupleTools.jl?branch=master) [![codecov.io](http://codecov.io/github/Jutho/TupleTools.jl/coverage.svg?branch=master)](http://codecov.io/github/Jutho/TupleTools.jl?branch=master)
 
 
-A bunch of tools for using tuples (mostly homogeneous tuples `NTuple{N}`) as a collection and performing a number of operations with an inferrable result, typically also an `NTuple{M}` with inferable length `M`. Type inference breaks down if some of the final or intermediate tuples exceed `MAX_TUPLETYPE_LEN`, meaning inference typically works up to output tuples of length `13` or `14`. Chosen implementations are typically faster than the corresponding functions in base for those small tuple lengths, but can be slower for larger tuples. Inference also breaks down for most functions in case of inhomogeneous tuples. Some algorithms also provide reasonable defaults assuming that they are used for tuples of `Int`s, i.e. `TupleTools.sum(()) = 0` or `TupleTools.prod(()) = 1` (whereas the corresponding Base functions would error). This originates from the assumption that these methods are used to operate on tuples of e.g. sizes, indices or strides of multidimensional arrays.
+A bunch of tools for using tuples (mostly homogeneous tuples `NTuple{N}`) as a collection and performing a number of operations with an inferrable result, typically also an `NTuple{M}` with inferable length `M`. ~~Type inference breaks down if some of the final or intermediate tuples exceed `MAX_TUPLETYPE_LEN`, meaning inference typically works up to output tuples of length `13` or `14`.~~ Chosen implementations are typically faster than the corresponding functions in base for those small tuple lengths, but can be slower for larger tuples. Inference breaks down for most functions in case of inhomogeneous tuples.
 
 
-Note that none of the following functions are exported, since their name often collides with the equivalent functions (with different implementations) in `Base`.
+Note that none of the following functions are exported, since their name often collides with the equivalent functions (with different implementations) in `Base`. Some functions here provided just have an equivalent in `Base` that doesn't work for tuples at all, like `sort`. Some functions also provide reasonable defaults assuming that they are used for tuples of `Int`s, i.e. `TupleTools.sum(()) = 0` or `TupleTools.prod(()) = 1` (whereas the corresponding `Base` functions would error). This originates from the assumption that these methods are used to operate on tuples of e.g. sizes, indices or strides of multidimensional arrays.
 
 
 <a id='Types-1'></a>
@@ -39,7 +39,7 @@ StaticLength(N₁) - StaticLength(N₂) == StaticLength(max(0, N₁-N₂))
 ```
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L8-L22' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L10-L24' class='documenter-source'>source</a><br>
 
 
 <a id='Functions-1'></a>
@@ -58,7 +58,7 @@ tail2(t::Tuple) -> ::Tuple
 Returns a tuple with the first two elements stripped, equivalent to `tail(tail(t))`
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L37-L41' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L34-L38' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.unsafe_tail' href='#TupleTools.unsafe_tail'>#</a>
 **`TupleTools.unsafe_tail`** &mdash; *Function*.
@@ -72,7 +72,7 @@ unsafe_tail(t::Tuple) -> ::Tuple
 Returns a tuple with the first element stripped, similar to `tail(t)`, but does not error on an empty tuple (instead returning an empty tuple again). An empty tuple is thus the fixed point of this function.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L44-L50' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L41-L47' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.unsafe_front' href='#TupleTools.unsafe_front'>#</a>
 **`TupleTools.unsafe_front`** &mdash; *Function*.
@@ -86,7 +86,7 @@ unsafe_front(t::Tuple) -> ::Tuple
 Returns a tuple with the last element stripped, similar to `front(t)`, but does not error on an empty tuple (instead returning an empty tuple again). An empty tuple is thus the fixed point of this function.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L54-L60' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L51-L57' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.getindices' href='#TupleTools.getindices'>#</a>
 **`TupleTools.getindices`** &mdash; *Function*.
@@ -100,7 +100,7 @@ getindices(t::Tuple, I::Tuple{Vararg{Int}}) -> ::Tuple
 Get the indices `t[i] for i in I`, again as tuple.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L288-L292' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L272-L276' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.deleteat' href='#TupleTools.deleteat'>#</a>
 **`TupleTools.deleteat`** &mdash; *Function*.
@@ -115,7 +115,7 @@ deleteat(t::Tuple, I::Tuple{Vararg{Int}}) -> ::Tuple
 Delete the element at location `i` in `t`; if a list `I` of indices is specified (again as a tuple), the elements of these different positions are deleted.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L76-L82' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L73-L79' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.insertat' href='#TupleTools.insertat'>#</a>
 **`TupleTools.insertat`** &mdash; *Function*.
@@ -129,7 +129,7 @@ insertat(t::Tuple, i::Int, t2::Tuple) -> ::Tuple
 Insert the elements of tuple `t2` at location `i` in `t`, i.e. the output tuple will look as (t[1:i-1]..., t2..., t[i+1:end]). Note that element `t[i]` is deleted. Use `setindex` for setting a single value at position `i`, or `insertafter(t, i, t2)` to insert the contents of `t2` in between element `i` and `i+1` in `t`.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L97-L105' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L94-L101' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.insertafter' href='#TupleTools.insertafter'>#</a>
 **`TupleTools.insertafter`** &mdash; *Function*.
@@ -143,7 +143,7 @@ insertafter(t::Tuple, i::Int, t2::Tuple) -> ::Tuple
 Insert the elements of tuple `t2` after location `i` in `t`, i.e. the output tuple will look as (t[1:i]..., t2..., t[i+1:end]). Use index `i=0` or just `(t2..., t...)` to insert `t2` in front of `t`; also see `insertat` to overwrite the element at position `i`.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L110-L117' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L108-L114' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.vcat' href='#TupleTools.vcat'>#</a>
 **`TupleTools.vcat`** &mdash; *Function*.
@@ -157,7 +157,7 @@ vcat(args...) -> ::Tuple
 Like `vcat` for tuples, concatenates a combination of tuple arguments and non-tuple arguments into a single tuple. Only works one level deep, i.e. tuples in tuples are not expanded.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L64-L70' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L61-L67' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.sum' href='#TupleTools.sum'>#</a>
 **`TupleTools.sum`** &mdash; *Function*.
@@ -171,7 +171,7 @@ sum(t::Tuple)
 Returns the sum of the element of a tuple, or `0` for an empty tuple.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L122-L126' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L122-L126' class='documenter-source'>source</a><br>
 
 <a id='Base.cumsum' href='#Base.cumsum'>#</a>
 **`Base.cumsum`** &mdash; *Function*.
@@ -185,7 +185,21 @@ cumsum(t::Tuple)
 Returns the cumulative sum of the elements of a tuple, or `()` for an empty tuple.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L131-L135' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L131-L135' class='documenter-source'>source</a><br>
+
+<a id='TupleTools.diff' href='#TupleTools.diff'>#</a>
+**`TupleTools.diff`** &mdash; *Function*.
+
+
+
+```
+diff(v::Tuple) -> Tuple
+```
+
+Finite difference operator of tuple `v`.
+
+
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L318-L322' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.prod' href='#TupleTools.prod'>#</a>
 **`TupleTools.prod`** &mdash; *Function*.
@@ -199,7 +213,7 @@ prod(t::Tuple)
 Returns the product of the elements of a tuple, or `1` for an empty tuple.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L143-L147' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L143-L147' class='documenter-source'>source</a><br>
 
 <a id='Base.cumprod' href='#Base.cumprod'>#</a>
 **`Base.cumprod`** &mdash; *Function*.
@@ -213,7 +227,7 @@ cumprod(t::Tuple)
 Returns the cumulative product of the elements of a tuple, or `()` for an empty tuple.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L152-L156' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L152-L156' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.minimum' href='#TupleTools.minimum'>#</a>
 **`TupleTools.minimum`** &mdash; *Function*.
@@ -227,7 +241,7 @@ minimum(t::Tuple)
 Returns the smallest element of a tuple
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L164-L168' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L164-L168' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.maximum' href='#TupleTools.maximum'>#</a>
 **`TupleTools.maximum`** &mdash; *Function*.
@@ -241,7 +255,7 @@ maximum(t::Tuple)
 Returns the largest element of a tuple
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L172-L176' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L172-L176' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.findmin' href='#TupleTools.findmin'>#</a>
 **`TupleTools.findmin`** &mdash; *Function*.
@@ -255,7 +269,7 @@ findmin(t::Tuple)
 Returns the value and index of the minimum element in a tuple. If there are multiple minimal elements, then the first one will be returned.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L198-L203' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L196-L201' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.findmax' href='#TupleTools.findmax'>#</a>
 **`TupleTools.findmax`** &mdash; *Function*.
@@ -269,7 +283,7 @@ findmax(t::Tuple)
 Returns the value and index of the maximum element in a tuple. If there are multiple maximal elements, then the first one will be returned.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L215-L220' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L213-L218' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.argmin' href='#TupleTools.argmin'>#</a>
 **`TupleTools.argmin`** &mdash; *Function*.
@@ -283,7 +297,7 @@ argmin(t::Tuple)
 Returns the index of the minimum element in a tuple. If there are multiple minimal elements, then the first one will be returned.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L181-L186' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L180-L185' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.argmax' href='#TupleTools.argmax'>#</a>
 **`TupleTools.argmax`** &mdash; *Function*.
@@ -297,7 +311,7 @@ argmax(t::Tuple)
 Returns the index of the maximum element in a tuple. If there are multiple minimal elements, then the first one will be returned.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L190-L195' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L188-L193' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.sort' href='#TupleTools.sort'>#</a>
 **`TupleTools.sort`** &mdash; *Function*.
@@ -311,7 +325,7 @@ sort(t::Tuple; lt=isless, by=identity, rev::Bool=false) -> ::Tuple
 Sorts the tuple `t`.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L234-L238' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L230-L234' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.sortperm' href='#TupleTools.sortperm'>#</a>
 **`TupleTools.sortperm`** &mdash; *Function*.
@@ -325,7 +339,7 @@ sortperm(t::Tuple; lt=isless, by=identity, rev::Bool=false) -> ::Tuple
 Computes a tuple that contains the permutation required to sort `t`.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L260-L265' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L261-L266' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.isperm' href='#TupleTools.isperm'>#</a>
 **`TupleTools.isperm`** &mdash; *Function*.
@@ -339,7 +353,7 @@ isperm(p) -> ::Bool
 A non-allocating alternative to Base.isperm(p) that is much faster for small permutations.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L307-L311' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L295-L299' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.invperm' href='#TupleTools.invperm'>#</a>
 **`TupleTools.invperm`** &mdash; *Function*.
@@ -353,7 +367,7 @@ invperm(p::NTuple{N,Int}) -> ::NTuple{N,Int}
 Inverse permutation of a permutation `p`.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L323-L327' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L311-L315' class='documenter-source'>source</a><br>
 
 <a id='TupleTools.permute' href='#TupleTools.permute'>#</a>
 **`TupleTools.permute`** &mdash; *Function*.
@@ -367,5 +381,5 @@ permute(t::Tuple, p) -> ::Tuple
 Permute the elements of tuple `t` according to the permutation in `p`.
 
 
-<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/a898092ea5bed41dd20e64ef8e6d7010b2e12d64/src/TupleTools.jl#L296-L300' class='documenter-source'>source</a><br>
+<a target='_blank' href='https://github.com/Jutho/TupleTools.jl/blob/ebd92dd11b34ed902f88c9c6a4e61bbadf3c3a19/src/TupleTools.jl#L281-L285' class='documenter-source'>source</a><br>
 

docs/make.jl

@@ -1,3 +1,9 @@
-using Documenter, TupleTools
+using Documenter, DocumenterMarkdown, TupleTools
 
-makedocs(modules=[TupleTools])
+makedocs(modules=[TupleTools],
+            sitename="TupleTools.jl",
+            authors = "Jutho Haegeman",
+            format = DocumenterMarkdown.Markdown(),
+            pages = [
+                "Home" => "index.md",
+            ])