File: properties.html

package info (click to toggle)

pyelemental 1.2.0-2

links: PTS, VCS
area: main
in suites: squeeze
size: 344 kB
ctags: 244
sloc: cpp: 1,847; xml: 613; python: 46; makefile: 28; sh: 11

file content (3 lines) | stat: -rw-r--r-- 21,080 bytes

parent folder | download | duplicates (2)

1
2
3

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Categories and properties</title><meta name="generator" content="DocBook XSL Stylesheets V1.70.1" /><link rel="start" href="index.html" title="pyElemental reference" /><link rel="up" href="index.html" title="pyElemental reference" /><link rel="prev" href="value-types.html" title="Value types" /><link rel="next" href="table.html" title="Periodic table" /><link rel="copyright" href="ln-legalnotice.html" title="Legal Notice" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Categories and properties</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="value-types.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="table.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="properties"></a>Categories and properties</h2></div></div></div><p>These attributes are available at the module level:</p><div class="variablelist"><dl><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">list(Category) </span><strong class="varname">categories</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Category </span><strong class="varname">C_GENERAL</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Category </span><strong class="varname">C_HISTORICAL</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Category </span><strong class="varname">C_PHYSICAL</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Category </span><strong class="varname">C_THERMAL</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Category </span><strong class="varname">C_ATOMIC</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Category </span><strong class="varname">C_CRYSTALLOGRAPHIC</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Category </span><strong class="varname">C_ELECTRONIC</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Category </span><strong class="varname">C_MISCELLANEOUS</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>The <a href="properties.html#class-Category" title="class Category">categories</a> of available properties of the chemical elements, and a list thereof.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_NAME</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_OFFICIAL_NAME</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_ALTERNATE_NAME</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_SYMBOL</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_NUMBER</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_SERIES</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_GROUP</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_PERIOD</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_BLOCK</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_DISCOVERY</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_DISCOVERED_BY</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_ETYMOLOGY</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_PHASE</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_DENSITY_SOLID</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_DENSITY_LIQUID</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_DENSITY_GAS</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_APPEARANCE</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_MELTING_POINT</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_BOILING_POINT</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_FUSION_HEAT</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_VAPORIZATION_HEAT</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_SPECIFIC_HEAT</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_THERMAL_CONDUCTIVITY</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_DEBYE_TEMPERATURE</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_ATOMIC_MASS</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_ATOMIC_VOLUME</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_ATOMIC_RADIUS</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_COVALENT_RADIUS</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_VAN_DER_WAALS_RADIUS</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_IONIC_RADII</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_LATTICE_TYPE</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_SPACE_GROUP</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_LATTICE_EDGES</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_LATTICE_ANGLES</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_LATTICE_VOLUME</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_CONFIGURATION</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_OXIDATION_STATES</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_ELECTRONEGATIVITY</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_ELECTRON_AFFINITY</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">FloatProperty </span><strong class="varname">P_FIRST_ENERGY</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_COLOR</strong></code> — <em xmlns="">read-only</em><br /></span><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">Property </span><strong class="varname">P_NOTES</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>The available <a href="properties.html#class-Property" title="class Property">properties</a> (including <a href="properties.html#class-FloatProperty" title="class FloatProperty">floating-point properties</a>) of the chemical elements. For details, see the <code class="varname">description</code> attribute of each property.</p></dd></dl></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="class-Property"></a>class <code class="classname">Property</code></h3></div></div></div><p>A property of the chemical elements. Property instances are accessible through the <code class="varname">properties</code> <span class="type">list</span>s of <a href="properties.html#class-Category" title="class Category">categories</a>, or as module-level attributes (see <a href="properties.html" title="Categories and properties">above</a>).</p><div class="variablelist"><dl><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">unicode </span><strong class="varname">name</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>The translated name of the property.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">bool </span><strong class="varname">has_format</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>Whether a compose-style format for values is defined.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">unicode </span><strong class="varname">format</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>A translated compose-style format for values of the property. If the format is undefined, an empty string.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">unicode </span><strong class="varname">description</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>A translated explanatory description of the property.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">list(Message) </span><strong class="varname">sources</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>Citations for the sources of values for the property, as <code class="classname"><a href="value-types.html#class-Message">Message</a></code>s.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">bool </span><strong class="varname">is_colorable</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>Whether values of the property have color representations.</p></dd><dt><span class="term"><code xmlns="" class="methodsynopsis"><span class="void">null </span><strong class="methodname">make_entry</strong> (<span class="methodparam"><span class="type">EntriesView </span><var class="parameter">view</var></span>, <span class="methodparam"><span class="type">unicode|value_base </span><var class="parameter">value</var></span>)</code></span></dt><dd><p>Possibly adds a value for this property to an <code class="classname"><a href="value.html#class-EntriesView">EntriesView</a></code>. If <em class="parameter"><code>value</code></em> is <span class="type">unicode</span>, an entry will always be made. If <em class="parameter"><code>value</code></em> is a <code class="classname"><a href="value.html#class-value_base">value_base</a></code> subclass, an entry will be made only if <em class="parameter"><code>value</code></em> is defined or belongs to an always-output class.</p><div class="variablelist"><table border="0"><col align="left" valign="top" /><tbody><tr><td><span class="term"><em class="parameter"><code>view</code></em></span></td><td>The <code class="classname">EntriesView</code> to be populated.</td></tr><tr><td><span class="term"><em class="parameter"><code>value</code></em></span></td><td>The value to be added.</td></tr></tbody></table></div></dd></dl></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="class-FloatProperty"></a>class <code class="classname">FloatProperty</code></h3></div></div></div><p>A floating-point property of the chemical elements. Inherits from <code class="classname"><a href="properties.html#class-Property">Property</a></code>.</p><div class="variablelist"><dl><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">bool </span><strong class="varname">is_scale_valid</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>Whether the scale of values for this property is valid. The scale is valid if one or more elements has a defined value for this property and those values are not all equal.</p></dd><dt><span class="term"><code xmlns="" class="methodsynopsis"><span class="type">float </span><strong class="methodname">get_scale_position</strong> (<span class="methodparam"><span class="type">Float </span><var class="parameter">instance</var></span>[, <span class="methodparam"><span class="type">bool </span><var class="parameter">logarithmic</var><span class="initializer">=False</span></span>])</code></span></dt><dd><p>Returns the position on a normalized 0.0 to 1.0 scale for an instance of this property. Raises <code class="exceptionname">ValueError</code> if the property does not have a valid scale, or if <em class="parameter"><code>instance</code></em> is not a defined value.</p><div class="variablelist"><table border="0"><col align="left" valign="top" /><tbody><tr><td><span class="term"><em class="parameter"><code>instance</code></em></span></td><td>A defined <code class="classname"><a href="value-types.html#class-Float">Float</a></code> value for this property.</td></tr><tr><td><span class="term"><em class="parameter"><code>logarithmic</code></em></span></td><td>Whether to compute the position on a logarithmic instead of linear scale.</td></tr></tbody></table></div></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">float </span><strong class="varname">minimum</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>The least value of this property for any element. Raises <code class="exceptionname">ValueError</code> if the property does not have a valid scale.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">float </span><strong class="varname">linear_medium</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>The value of this property that has a position of 0.5 on a linear scale. Raises <code class="exceptionname">ValueError</code> if the property does not have a valid scale.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">float </span><strong class="varname">logarithmic_medium</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>The value of this property that has a position of 0.5 on a logarithmic scale. Raises <code class="exceptionname">ValueError</code> if the property does not have a valid scale.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">float </span><strong class="varname">maximum</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>The greatest value of this property for any element. Raises <code class="exceptionname">ValueError</code> if the property does not have a valid scale.</p></dd></dl></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="class-Category"></a>class <code class="classname">Category</code></h3></div></div></div><p>A category of properties of the chemical elements. Categories instances are accessible through the <code class="varname">categories</code> <span class="type">list</span>, or as module-level attributes (see <a href="properties.html" title="Categories and properties">above</a>).</p><div class="variablelist"><dl><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">unicode </span><strong class="varname">name</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>The translated name of the category.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">list(Property) </span><strong class="varname">properties</strong></code> — <em xmlns="">read-only</em></span></dt><dd><p>The <a href="properties.html#class-Property" title="class Property">properties</a> in the category.</p></dd><dt><span class="term"><code xmlns="" class="methodsynopsis"><span class="void">null </span><strong class="methodname">make_header</strong> (<span class="methodparam"><span class="type">EntriesView </span><var class="parameter">view</var></span>)</code></span></dt><dd><p>Adds the category name to an EntriesView.</p><div class="variablelist"><table border="0"><col align="left" valign="top" /><tbody><tr><td><span class="term"><em class="parameter"><code>view</code></em></span></td><td>The <code class="classname"><a href="value.html#class-EntriesView">EntriesView</a></code> to be populated.</td></tr></tbody></table></div></dd></dl></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="value-types.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="table.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Value types </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Periodic table</td></tr></table></div></body></html>