Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 2.13 KB

README.md

File metadata and controls

73 lines (51 loc) · 2.13 KB
Raw

Marshall's Algorithms and Data Structures Library

Table of Contents

  1. Description

  2. System Requirements

  3. Building, Installing, and Generating Documentation

  4. Available Features

  5. Credits

Description

This is a library I've created which is suitable to housing and testing various algorithms or data structures which I have found missing or lacking amongst the current breadth of C++ libraries. My focus is on bioinformatics related works, but I have taken some pains to make them general.

System Requirements

Building Requirements: gcc-libs, g++, libc, git, make, bison >= 3.0.4, flex

Use Requirements: libc

Documentation Requirements: Doxygen

Building and Installing

Build:

$ make

Debug:

$ make debug
$ ./test/test.out

Install:

# make install

Generate Documentation:

$cd doc/
$doxygen Doxyfile

Available Features

Algorithms:

  • Pearson Correlation Matrix generation
  • Kendall Correlation Matrix generation
  • Spearman Correlation Matrix generation
  • Simple Semi-Automated Thread dispatcher using pthreads
  • Various statistical functions
  • Quick-Merge Sort
  • GEO's .soft file format general parser

Datastructures:

  • Upper Diagonal Square Matrix template, memory optimized
  • Undirected Graph, Vertex, and Edge templates
  • bitpacked array, and sparse bitpacked array
  • universal GEO .soft file format container

Credits

Primary Author: Josh Marshall ([email protected])
Conributors: Victor Claremboux