removed eta

README.md

@@ -40,7 +40,7 @@ You may get **WARN**INGs upon compilation. You can safely ignore them for most p
     [...]
 ```
 
-The Sequencer also calculates a fitness coefficient `η` (`\eta`+`TAB` at the REPL) that can be used to compare quality of solutions using various metrics and scales against the same data. Bigger is better. η is also called `elongation` in SequencerJ. The accessor is `elong`.
+The Sequencer also calculates a fitness coefficient `η` that can be used to compare quality of solutions using various metrics and scales against the same data. Bigger is better. η is returned by the `elong` function.
 ```julia
     julia> eta = elong(seqres)
     6.2345

docs/src/api.md

@@ -26,7 +26,6 @@ elong
 order
 mst
 D
-η
 
 EMD()
 EMD(u::AbstractVector{T}, v::AbstractVector{T}) where {T <: Real}

src/SequencerJ.jl

@@ -21,7 +21,7 @@ include("distancemetrics.jl")
 include("sequencer.jl")
 
 # functions
-export sequence, autoscale, D, mst, elong, η, elongation, order, prettyp, loss, ensuregrid!
+export sequence, autoscale, D, mst, elong, elongation, order, prettyp, loss, ensuregrid!
 export emd, energy
 
 # types

src/sequencer.jl

@@ -19,15 +19,6 @@ struct SequencerResult
     order::AbstractVector #final ordering from bfs
 end
 
-"""
-
-    η(r::SequencerResult)
-
-Alias for `elong`, returns the final graph elongation of a Sequencer run. (Greek letter `eta`)
-
-"""
-η(r::SequencerResult) = elong(r)
-
 """
 
     D(r::SequencerResult)

test/runtests.jl

@@ -187,7 +187,7 @@ using Images
 
     @testset "Accessor functions" begin    
         seqres = sequence(SMALL; scales=(2,), metrics=(L2,))
-        for f in (:elong, :order, :D, :mst, :η)
+        for f in (:elong, :order, :D, :mst)
             @testset "$f" begin
                 @eval @test $f($seqres) !==nothing
             end