annotate mayachemtools/docs/modules/txt/MolecularFormula.txt @ 9:ab29fa5c8c1f draft default tip

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