NAME

WordNet::vectorFile - Provides access to the word vectors database (used by the vector and vector_pairs WordNet::Similarity measures).

SYNOPSIS

  use WordNet::vectorFile;

  my ($dCount, $dims, $vecRef) = WordNet::vectorFile->readVectors($filename);

  WordNet::vectorFile->writeVectors($fname, $dCount, $dims, $vecRef);

DESCRIPTION

This module provides a read/write interface into the word vectors data file. This module is used by WordNet::Similarity::vector and WordNet::Similarity::vector_pairs as an interface into the word vectors database. This module abstracts the format of the data file away from the user.

Methods

readVectors

This method reads in a word vectors file, and returns the document count, the words corresponding to the dimensions of the vectors, and a reference to an array containing the list of word vectors.

Parameters: $file -- the file name of the word vectors file.

Returns: ($dCount, $dims, $vecRef)

writeVectors

This method writes out a list of word vectors to the word vectors file.

Parameters: $fname, $dCount, $dims, $vecRef

Returns: none

AUTHORS

 Ted Pedersen, University of Minnesota Duluth
 tpederse at d.umn.edu

 Siddharth Patwardhan, University of Utah, Salt Lake City
 sidd at cs.utah.edu

BUGS

None.

To report bugs, go to http://groups.yahoo.com/group/wn-similarity/ or e-mail "tpederse at d.umn.edu".

COPYRIGHT AND LICENSE

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 2 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, write to

   The Free Software Foundation, Inc.,
   59 Temple Place - Suite 330,
   Boston, MA  02111-1307, USA.

Note: a copy of the GNU General Public License is available on the web at <http://www.gnu.org/licenses/gpl.txt> and is included in this distribution as GPL.txt.