File: table.hh

package info (click to toggle)
gelemental 1.2.0-5
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 3,412 kB
  • ctags: 705
  • sloc: sh: 11,797; cpp: 5,255; makefile: 197
file content (66 lines) | stat: -rw-r--r-- 2,458 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
//! \file table.hh
//! Functions for access to the entire table.
/*
 * This file is part of libelemental, a periodic table library with detailed
 * information on elements.
 *
 * Copyright (C) 2006-2007 Kevin Daughtridge <kevin@kdau.com>
 * Copyright (C) 2003 Jonas Frantz <jonas.frantz@welho.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBELEMENTAL__TABLE_HH
#define LIBELEMENTAL__TABLE_HH

#include <libelemental/value.hh>
#include <libelemental/value-types.hh>
#include <libelemental/element.hh>

#include <stdexcept>

//******************************************************************************

namespace Elemental {

//! The periodic table of elements.
typedef std::vector<const Element*> Table;

//! Initializes libelemental.
/*! This function may be called more than once. This function, or one of the
 * get_table() or get_element() functions, which call it, should be called
 * before any other features in the library are used. */
void initialize () throw ();

//! Returns the periodic table of elements.
//! The table is a singleton.
const Table& get_table () throw ();

//! Returns the element with a given atomic number.
/*! \param number The atomic number of an element.
 * \return A reference to the corresponding element.
 * \throw std::out_of_range if the atomic number is invalid. */
const Element& get_element (AtomicNumber number) throw (std::out_of_range);

//! Returns the element with a given symbol or atomic number.
/*! \param which The standard symbol of an element, or the string representation
 * of the atomic number of an element.
 * \return A reference to the corresponding element.
 * \throw std::invalid_argument if the symbol or number is invalid. */
const Element& get_element (const std::string& which)
	throw (std::invalid_argument);

} // namespace Elemental

#endif // LIBELEMENTAL__TABLE_HH