Skip to content

Commit

Permalink
Merge pull request #31 from dpryan79/rename_header
Browse files Browse the repository at this point in the history
Rename io.h
  • Loading branch information
dpryan79 authored Jul 24, 2017
2 parents 1a0cc33 + 3a2cc67 commit 9a2936c
Show file tree
Hide file tree
Showing 117 changed files with 1,922 additions and 819 deletions.
4 changes: 2 additions & 2 deletions bigWig.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#include "io.h"
#include "bigWigIO.h"
#include "bwValues.h"
#include <inttypes.h>
#include <zlib.h>
Expand Down Expand Up @@ -53,7 +53,7 @@ extern "C" {
/*!
* The library version number
*/
#define LIBBIGWIG_VERSION 0.3.4
#define LIBBIGWIG_VERSION 0.4.0

/*!
* If 1, then this library was compiled with remote file support.
Expand Down
2 changes: 1 addition & 1 deletion io.h → bigWigIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ typedef void CURL;
#define CURLE_OK 0
#define CURLE_FAILED_INIT 1
#endif
/*! \file io.h
/*! \file bigWigIO.h
* These are (typically internal) IO functions, so there's generally no need for you to directly use them!
*/

Expand Down
325 changes: 325 additions & 0 deletions docs/html/BigWigIO_8h.html

Large diffs are not rendered by default.

112 changes: 112 additions & 0 deletions docs/html/BigWigIO_8h_source.html

Large diffs are not rendered by default.

41 changes: 20 additions & 21 deletions docs/html/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,15 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>libBigWig: Data Structures</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
Expand All @@ -22,7 +21,7 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<td style="padding-left: 0.5em;">
<div id="projectname">libBigWig
</div>
</td>
Expand All @@ -31,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
Expand Down Expand Up @@ -72,7 +71,7 @@
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
Expand All @@ -88,27 +87,27 @@
<div class="contents">
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbbOverlappingEntries__t.html" target="_self">bbOverlappingEntries_t</a></td><td class="desc">Holds interval:str associations </td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbigWigFile__t.html" target="_self">bigWigFile_t</a></td><td class="desc">A structure that holds everything needed to access a bigWig file </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbigWigHdr__t.html" target="_self">bigWigHdr_t</a></td><td class="desc">The header section of a bigWig file </td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbwDataHeader__t.html" target="_self">bwDataHeader_t</a></td><td class="desc">The header section of a given data block </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbwOverlapBlock__t.html" target="_self">bwOverlapBlock_t</a></td><td class="desc">This structure holds the data blocks that overlap a given interval </td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbwOverlapIterator__t.html" target="_self">bwOverlapIterator_t</a></td><td class="desc">A structure to hold iterations One of intervals and entries should be used to access records from bigWig or bigBed files, respectively </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbwOverlappingIntervals__t.html" target="_self">bwOverlappingIntervals_t</a></td><td class="desc">Holds interval:value associations </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbwRTree__t.html" target="_self">bwRTree_t</a></td><td class="desc"></td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbwRTreeNode__t.html" target="_self">bwRTreeNode_t</a></td><td class="desc">A node within an R-tree holding the index for data </td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbwWriteBuffer__t.html" target="_self">bwWriteBuffer_t</a></td><td class="desc">This is only needed for writing bigWig files (and won't be created otherwise) This should be removed from <a class="el" href="bigWig_8h.html">bigWig.h</a> </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structbwZoomHdr__t.html" target="_self">bwZoomHdr_t</a></td><td class="desc">BigWig files have multiple "zoom" levels, each of which has its own header. This hold those headers </td></tr>
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structchromList__t.html" target="_self">chromList_t</a></td><td class="desc">Holds the chromosomes and their lengths </td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structURL__t.html" target="_self">URL_t</a></td><td class="desc">This structure holds the file pointers and buffers needed for raw access to local and remote files </td></tr>
<tr id="row_0_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structbbOverlappingEntries__t.html" target="_self">bbOverlappingEntries_t</a></td><td class="desc">Holds interval:str associations </td></tr>
<tr id="row_1_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structbigWigFile__t.html" target="_self">bigWigFile_t</a></td><td class="desc">A structure that holds everything needed to access a bigWig file </td></tr>
<tr id="row_2_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structbigWigHdr__t.html" target="_self">bigWigHdr_t</a></td><td class="desc">The header section of a bigWig file </td></tr>
<tr id="row_3_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structbwDataHeader__t.html" target="_self">bwDataHeader_t</a></td><td class="desc">The header section of a given data block </td></tr>
<tr id="row_4_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structbwOverlapBlock__t.html" target="_self">bwOverlapBlock_t</a></td><td class="desc">This structure holds the data blocks that overlap a given interval </td></tr>
<tr id="row_5_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structbwOverlapIterator__t.html" target="_self">bwOverlapIterator_t</a></td><td class="desc">A structure to hold iterations One of intervals and entries should be used to access records from bigWig or bigBed files, respectively </td></tr>
<tr id="row_6_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structbwOverlappingIntervals__t.html" target="_self">bwOverlappingIntervals_t</a></td><td class="desc">Holds interval:value associations </td></tr>
<tr id="row_7_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structbwRTree__t.html" target="_self">bwRTree_t</a></td><td class="desc"></td></tr>
<tr id="row_8_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structbwRTreeNode__t.html" target="_self">bwRTreeNode_t</a></td><td class="desc">A node within an R-tree holding the index for data </td></tr>
<tr id="row_9_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structbwWriteBuffer__t.html" target="_self">bwWriteBuffer_t</a></td><td class="desc">This is only needed for writing bigWig files (and won't be created otherwise) This should be removed from <a class="el" href="bigWig_8h.html">bigWig.h</a> </td></tr>
<tr id="row_10_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structbwZoomHdr__t.html" target="_self">bwZoomHdr_t</a></td><td class="desc">BigWig files have multiple "zoom" levels, each of which has its own header. This hold those headers </td></tr>
<tr id="row_11_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structchromList__t.html" target="_self">chromList_t</a></td><td class="desc">Holds the chromosomes and their lengths </td></tr>
<tr id="row_12_" class="even"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structURL__t.html" target="_self">URL_t</a></td><td class="desc">This structure holds the file pointers and buffers needed for raw access to local and remote files </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Nov 18 2016 22:54:37 for libBigWig by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Jul 24 2017 09:40:02 for libBigWig by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</a> 1.8.6
</small></address>
</body>
</html>
Loading

0 comments on commit 9a2936c

Please sign in to comment.