Implement "cleanup" method

[leotrs]

Make sure the documentation highlights the fact that the user should remember to call remove_isolates and other related functions.
Implement a cleanup method that performs various common clean up tasks, see comment down thread.

[leotrs]

#39 implements remove_isolates

[leotrs]

Other ideas for 2 cleanup method: remove isolates, extract largest component, remove duplicate/multi edges, relabel the node ids.

[nwlandry]

So you're saying that we have a cleanup method that does these four steps? I like that idea and also we should add the possibility to collapse loopy hyperedges.

[leotrs]

So you're saying that we have a cleanup method that does these four steps?

We don't have it yet, but I want to implement it.

I like that idea and also we should add the possibility to collapse loopy hyperedges.

Good catch!

[leotrs]

For now I think it'd be nice to have something like the following:

class Hypergraph:
    ...
    def cleanup(self):
        self.remove_isolates()
        self.remove_singletons()
        self.collapse_loopy_edges()    # not implemented yet
        self.remove_duplicates()       # not implemented yet
        self.relabel_nodes()           # not implemented yet
    ...

What other operations should cleanup perform?

[leotrs]

Closed by #161