Files
fpocket/doc/deprecated/programmers_guide/html/atom_8h-source.html
2020-06-06 16:04:20 +02:00

159 lines
14 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>fpocket: atom.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<img src="fpocket_logo_small.png" width="545" height="150">
<!-- Generated by Doxygen 1.5.6 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
var num=this.id.replace(/[^[0-9]/g,'');
var button=this.firstChild;
var sectionDiv=document.getElementById('dynsection'+num);
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
sectionDiv.style.display='block';
button.src='open.gif';
}else{
sectionDiv.style.display='none';
button.src='closed.gif';
}
}
function initDynSections(){
var divs=document.getElementsByTagName('div');
var sectionCounter=1;
for(var i=0;i<divs.length-1;i++){
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
var header=divs[i];
var section=divs[i+1];
var button=header.firstChild;
if (button!='IMG'){
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
button=document.createElement('img');
divs[i].insertBefore(button,divs[i].firstChild);
}
header.style.cursor='pointer';
header.onclick=changeDisplayState;
header.id='dynheader'+sectionCounter;
button.src='closed.gif';
section.id='dynsection'+sectionCounter;
section.style.display='none';
section.style.marginLeft='14px';
sectionCounter++;
}
}
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>atom.h</h1><a href="atom_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> COPYRIGHT DISCLAIMER</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> Vincent Le Guilloux, Peter Schmidtke and Pierre Tuffery, hereby</span>
<a name="l00006"></a>00006 <span class="comment"> disclaim all copyright interest in the program “fpocket” (which</span>
<a name="l00007"></a>00007 <span class="comment"> performs protein cavity detection) written by Vincent Le Guilloux and Peter</span>
<a name="l00008"></a>00008 <span class="comment"> Schmidtke.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> Vincent Le Guilloux 28 November 2008</span>
<a name="l00011"></a>00011 <span class="comment"> Peter Schmidtke 28 November 2008</span>
<a name="l00012"></a>00012 <span class="comment"> Pierre Tuffery 28 November 2008</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> GNU GPL</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> This file is part of the fpocket package.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> fpocket is free software: you can redistribute it and/or modify</span>
<a name="l00019"></a>00019 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00020"></a>00020 <span class="comment"> the Free Software Foundation, either version 3 of the License, or</span>
<a name="l00021"></a>00021 <span class="comment"> (at your option) any later version.</span>
<a name="l00022"></a>00022 <span class="comment"></span>
<a name="l00023"></a>00023 <span class="comment"> fpocket is distributed in the hope that it will be useful,</span>
<a name="l00024"></a>00024 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00025"></a>00025 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00026"></a>00026 <span class="comment"> GNU General Public License for more details.</span>
<a name="l00027"></a>00027 <span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00029"></a>00029 <span class="comment"> along with fpocket. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
<a name="l00030"></a>00030 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment">**/</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="preprocessor">#ifndef DH_ATOM</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define DH_ATOM</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include &lt;stdio.h&gt;</span>
<a name="l00037"></a>00037 <span class="preprocessor">#include &lt;stdlib.h&gt;</span>
<a name="l00038"></a>00038 <span class="preprocessor">#include &lt;string.h&gt;</span>
<a name="l00039"></a>00039 <span class="preprocessor">#include &lt;ctype.h&gt;</span>
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="utils_8h.html">utils.h</a>"</span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="comment">// --------------------------------MACROS------------------------------------ */</span>
<a name="l00044"></a>00044
<a name="l00045"></a>00045
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="comment">// -------------------------- PUBLIC STRUCTURES ----------------------------- */</span>
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment">/**</span>
<a name="l00050"></a>00050 <span class="comment"> A structure for the modelisation of an atom</span>
<a name="l00051"></a>00051 <span class="comment">*/</span>
<a name="l00052"></a><a class="code" href="structs__atm.html">00052</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structs__atm.html">s_atm</a>
<a name="l00053"></a>00053 {
<a name="l00054"></a><a class="code" href="structs__atm.html#05407d7638ff7f6fc210026306def9b5">00054</a> <span class="keywordtype">int</span> <a class="code" href="structs__atm.html#05407d7638ff7f6fc210026306def9b5">sort_x</a>; <span class="comment">/**&lt; Index in the sorted tab by X coord */</span>
<a name="l00055"></a>00055
<a name="l00056"></a><a class="code" href="structs__atm.html#f7cae749a2d07ffb393317f12745170a">00056</a> <span class="keywordtype">float</span> <a class="code" href="structs__atm.html#2bf748fbcd9b6d0a472b292a6b244ed5">x</a>, <a class="code" href="structs__atm.html#72534af707e830760a209fec348bc1af">y</a>, <a class="code" href="structs__atm.html#f7cae749a2d07ffb393317f12745170a">z</a> ; <span class="comment">/**&lt; Coords */</span>
<a name="l00057"></a><a class="code" href="structs__atm.html#98466fdfcb021884beb229b1dca361ae">00057</a> <span class="keywordtype">char</span> <a class="code" href="structs__atm.html#2f0330a30f640668efdd726a6dd05a93">name</a>[5], <span class="comment">/**&lt; Atom name */</span>
<a name="l00058"></a>00058 <a class="code" href="structs__atm.html#98466fdfcb021884beb229b1dca361ae">type</a>[7], <span class="comment">/**&lt; Atom type */</span>
<a name="l00059"></a>00059 <a class="code" href="structs__atm.html#c5b9464bd67f2cca101f7bf6beabb223">chain</a>[2], <span class="comment">/**&lt; Chain name */</span>
<a name="l00060"></a>00060 <a class="code" href="structs__atm.html#c80daffa94edeadd30433f6653e08054">symbol</a>[3], <span class="comment">/**&lt; Chemical symbol of the atom */</span>
<a name="l00061"></a>00061 <a class="code" href="structs__atm.html#e0ff20f2c491a8b16c866d9b1386b6a5">res_name</a>[8]; <span class="comment">/**&lt; Atom residue name */</span>
<a name="l00062"></a>00062
<a name="l00063"></a><a class="code" href="structs__atm.html#46d588698400fc19733301d687cf98bd">00063</a> <span class="keywordtype">int</span> <a class="code" href="structs__atm.html#88237f06aa7a10cd6b382c19b800f230">id</a>, <span class="comment">/**&lt; Atom id */</span>
<a name="l00064"></a>00064 <a class="code" href="structs__atm.html#46d588698400fc19733301d687cf98bd">seen</a>, <span class="comment">/**&lt; Say if we have seen this atom during a neighbor search */</span>
<a name="l00065"></a>00065 <a class="code" href="structs__atm.html#7c42c076ce151f4af210bef730b2b88f">res_id</a>, <span class="comment">/**&lt; Atom residue ID */</span>
<a name="l00066"></a>00066 <a class="code" href="structs__atm.html#de270d849563cffcab038bcb5f5c6e97">atype</a>,
<a name="l00067"></a>00067 <a class="code" href="structs__atm.html#a03a199ed11108d7710547df629c7d73">charge</a> ; <span class="comment">/**&lt; Atom charge */</span>
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">/* Optional fields */</span>
<a name="l00070"></a><a class="code" href="structs__atm.html#28c2d3bc2d95eb928ea6b5d37184d7f4">00070</a> <span class="keywordtype">float</span> <a class="code" href="structs__atm.html#ebbe1b323a702c23ef5bb21888adb6a8">mass</a>, <span class="comment">/**&lt; Mass */</span>
<a name="l00071"></a>00071 <a class="code" href="structs__atm.html#28c2d3bc2d95eb928ea6b5d37184d7f4">radius</a>, <span class="comment">/**&lt; Vdw radius */</span>
<a name="l00072"></a>00072 <a class="code" href="structs__atm.html#f41b525ee3032d47baf2db10387f022c">electroneg</a>, <span class="comment">/**&lt; Electronegativity */</span>
<a name="l00073"></a>00073 <a class="code" href="structs__atm.html#1696926c680a1014360598d54a1dadb0">occupancy</a>, <span class="comment">/**&lt; Occupancy */</span>
<a name="l00074"></a>00074 <a class="code" href="structs__atm.html#6a1a5fd32629457dfa14626b25b5ae46">bfactor</a> ; <span class="comment">/**&lt; B-factor for christal structures */</span>
<a name="l00075"></a>00075
<a name="l00076"></a><a class="code" href="structs__atm.html#bfd1f905200f69dd9cd9750fd305cf46">00076</a> <span class="keywordtype">char</span> <a class="code" href="structs__atm.html#bfd1f905200f69dd9cd9750fd305cf46">pdb_insert</a>, <span class="comment">/**&lt; PDB insertion code */</span>
<a name="l00077"></a>00077 <a class="code" href="structs__atm.html#58eeb8a80942caa3bd2374f3175cb77d">pdb_aloc</a>; <span class="comment">/**&lt; PDB alternate location code */</span>
<a name="l00078"></a>00078
<a name="l00079"></a><a class="code" href="structs__atm.html#e490809411c7c78662727873d499c730">00079</a> <span class="keywordtype">int</span> <a class="code" href="structs__atm.html#e490809411c7c78662727873d499c730">atomic_num</a> ; <span class="comment">/**&lt; Atomic number */</span>
<a name="l00080"></a>00080
<a name="l00081"></a>00081 } <a class="code" href="structs__atm.html">s_atm</a> ;
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="comment">/* --------------------------------PROTOTYPES--------------------------------- */</span>
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keywordtype">float</span> <a class="code" href="atom_8c.html#fa83a33583c67b9a3a4439b14000b983">get_mol_mass</a>(<a class="code" href="structs__atm.html">s_atm</a> *latoms, <span class="keywordtype">int</span> natoms) ;
<a name="l00086"></a>00086 <span class="keywordtype">float</span> <a class="code" href="atom_8c.html#6c124482d4ea1d4956cb095413e4b3af">get_mol_mass_ptr</a>(<a class="code" href="structs__atm.html">s_atm</a> **latoms, <span class="keywordtype">int</span> natoms);
<a name="l00087"></a>00087 <span class="keywordtype">void</span> <a class="code" href="atom_8c.html#6648ca5bb9d7384c43dda5156e333f24">set_mol_barycenter_ptr</a>(<a class="code" href="structs__atm.html">s_atm</a> **latoms, <span class="keywordtype">int</span> natoms, <span class="keywordtype">float</span> bary[3]) ;
<a name="l00088"></a>00088 <span class="keywordtype">float</span> <a class="code" href="atom_8c.html#d0f577a82cfdb135f707700c2b84e6a5">get_mol_volume_ptr</a>(<a class="code" href="structs__atm.html">s_atm</a> **atoms, <span class="keywordtype">int</span> natoms, <span class="keywordtype">int</span> niter) ;
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="keywordtype">int</span> <a class="code" href="atom_8c.html#a72221368b25d51716e4d59f02a8d753">is_in_lst_atm</a>(<a class="code" href="structs__atm.html">s_atm</a> **lst_atm, <span class="keywordtype">int</span> nb_atm, <span class="keywordtype">int</span> atm_id) ;
<a name="l00091"></a>00091 <span class="keywordtype">float</span> <a class="code" href="atom_8c.html#a960d66d3bd7cce701a12f56999056b4">atm_corsp</a>(<a class="code" href="structs__atm.html">s_atm</a> **al1, <span class="keywordtype">int</span> nl1, <a class="code" href="structs__atm.html">s_atm</a> **pocket_neigh, <span class="keywordtype">int</span> nal2) ;
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="atom_8c.html#9c0033f44cb65046ce5209b269da11d7">print_atoms</a>(FILE *f, <a class="code" href="structs__atm.html">s_atm</a> *atoms, <span class="keywordtype">int</span> natoms) ;
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 7 16:44:23 2010 for fpocket by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>