Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Pattern::Atom(3)      User Contributed Perl Documentation     Pattern::Atom(3)

NAME
       Chemistry::Pattern::Atom	- An atom that knows how to match

SYNOPSIS
	   my $patt_atom = Chemistry::Pattern::Atom->new(symbol	=> C);
	   $patt_atom->test_sub( sub {
	       my ($what, $where) = @_;
	       $where->bonds ==	3 ? 1 :	0; # only match	atoms with three bonds
	   });

DESCRIPTION
       Objects of this class represent atoms in	a pattern. This	is a subclass
       of Chemistry::Atom. In addition to the properties of regular atoms,
       pattern atoms have a method for testing if they match an	atom in	a
       molecule.  By default, a	pattern	atom matches an	atom if	they have the
       same symbol.  It	is possible to substitute this by an arbitrary
       criterion by providing a	custom test subroutine.

METHODS
       $patt_atom->test($atom)
	   Tests if the	pattern	atom matches the atom given by $atom. Returns
	   true	or false.

       $patt_atom->test_sub(\&my_test_sub)
	   Specify an arbitrary	test subroutine	to be used instead of the
	   default one.	 &my_test_sub must take	two parameters;	the first one
	   is the pattern atom and the second is the atom to match. It must
	   return true if there	is a match.

       $patt_atom->map_to([$atom])
	   Returns or sets the atom that is considered to be matched by
	   $patt_atom.

VERSION
       0.27

SEE ALSO
       Chemistry::Pattern

       The PerlMol website <http://www.perlmol.org/>

AUTHOR
       Ivan Tubert-Brohman <itub@cpan.org>

COPYRIGHT
       Copyright (c) 2009 Ivan Tubert-Brohman. All rights reserved. This
       program is free software; you can redistribute it and/or	modify it
       under the same terms as Perl itself.

perl v5.32.1			  2009-05-10		      Pattern::Atom(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | VERSION | SEE ALSO | AUTHOR | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Chemistry::Pattern::Atom&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help