annotate docs/modules/txt/MolecularFormula.txt @ 3:90ea638ce878 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:11:59 -0500
parents 2abf0d43254d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
2 MolecularFormula
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
3
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
5 use MolecularFormula;
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
6
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
7 use MolecularFormula qw(:all);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
8
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
10 MolecularFormula module provides the following functions:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
11
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
12 CalculateElementalComposition, CalculateExactMass,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
13 CalculateMolecularWeight, FormatCompositionInfomation,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
14 GetElementsAndCount, IsMolecularFormula
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
15
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
16 FUNCTIONS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
17 CalculateMolecularWeight
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
18 $MolecularWeight = CalculateMolecularWeight($MolecularFormula);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
19
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
20 Calculates and returns the molecular weight for a specified
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
21 *MolecularFormula*.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
22
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
23 CalculateElementalComposition
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
24 ($ElementsRef, $ElementCompositionRef) =
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
25 CalculateElementalComposition($MolecularFormula);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
26
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
27 Calculates the percent composition in a specified *MolecularFormula*
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
28 and returns references to arrays containing elements and their
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
29 percent composition.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
30
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
31 CalculateExactMass
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
32 $ExactMass = CalculateMolecularWeight($MolecularFormula);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
33
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
34 Calculates and returns the exact mass for a specified
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
35 *MolecularFormula*.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
36
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
37 FormatCompositionInfomation
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
38 $FormattedString = FormatCompositionInfomation($ElementsRef,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
39 $ElementCompositionRef, [$Precision]);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
40
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
41 Returns a formatted elemental composition string using references to
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
42 elements and elemental composition arrays. Precision is an optional
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
43 parameter; its default value is *2*.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
44
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
45 GetElementsAndCount
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
46 ($ElementsRef, $ElementCountRef) = GetElementsAndCount(
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
47 $MolecularFormula);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
48
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
49 Retrieves elements and their count composition in a specified
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
50 *MolecularFormula* and returns references to arrays containing
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
51 elements and their count.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
52
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
53 IsMolecularFormula
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
54 $Status = IsMolecularFormula($MolecularFormula);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
55 ($Status, $ErrorMsg) = IsMolecularFormula($MolecularFormula);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
56
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
57 Returns 1 or 0 a based on whether it's a valid *MolecularFormula*.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
58
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
59 AUTHOR
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
60 Manish Sud <msud@san.rr.com>
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
61
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
62 SEE ALSO
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
63 Molecule.pm
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
64
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
65 COPYRIGHT
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
66 Copyright (C) 2015 Manish Sud. All rights reserved.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
67
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
68 This file is part of MayaChemTools.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
69
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
70 MayaChemTools is free software; you can redistribute it and/or modify it
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
71 under the terms of the GNU Lesser General Public License as published by
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
72 the Free Software Foundation; either version 3 of the License, or (at
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
73 your option) any later version.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
74