home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _1e054ea578c84229f334050eca68584a < prev    next >
Encoding:
Text File  |  2000-03-23  |  9.2 KB  |  245 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tie::IxHash - ordered associative arrays for Perl</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Tie::IxHash - ordered associative arrays for Perl</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <UL>
  26.  
  27.         <LI><A HREF="#standard tiehash interface">Standard <CODE>TIEHASH</CODE> Interface</A></LI>
  28.         <LI><A HREF="#object interface">Object Interface</A></LI>
  29.     </UL>
  30.  
  31.     <LI><A HREF="#example">EXAMPLE</A></LI>
  32.     <LI><A HREF="#bugs">BUGS</A></LI>
  33.     <LI><A HREF="#todo">TODO</A></LI>
  34.     <LI><A HREF="#author">AUTHOR</A></LI>
  35.     <LI><A HREF="#version">VERSION</A></LI>
  36.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  37. </UL>
  38. <!-- INDEX END -->
  39.  
  40. <HR>
  41. <P>
  42. <H1><A NAME="name">NAME</A></H1>
  43. <P>Tie::IxHash - ordered associative arrays for Perl</P>
  44. <P>
  45. <HR>
  46. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  47. <UL>
  48. <LI>Linux</LI>
  49. <LI>Solaris</LI>
  50. <LI>Windows</LI>
  51. </UL>
  52. <HR>
  53. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  54. <PRE>
  55.     # simple usage
  56.     use Tie::IxHash;
  57.     tie HASHVARIABLE, Tie::IxHash [, LIST];
  58. </PRE>
  59. <PRE>
  60.  
  61.     # OO interface with more powerful features
  62.     use Tie::IxHash;
  63.     TIEOBJECT = Tie::IxHash->new( [LIST] );
  64.     TIEOBJECT->Splice( OFFSET [, LENGTH [, LIST]] );
  65.     TIEOBJECT->Push( LIST );
  66.     TIEOBJECT->Pop;
  67.     TIEOBJECT->Shift;
  68.     TIEOBJECT->Unshift( LIST );
  69.     TIEOBJECT->Keys( [LIST] );
  70.     TIEOBJECT->Values( [LIST] );
  71.     TIEOBJECT->Indices( LIST );
  72.     TIEOBJECT->Delete( [LIST] );
  73.     TIEOBJECT->Replace( OFFSET, VALUE, [KEY] );
  74.     TIEOBJECT->Reorder( LIST );
  75.     TIEOBJECT->SortByKey;
  76.     TIEOBJECT->SortByValue;
  77.     TIEOBJECT->Length;</PRE>
  78. <P>
  79. <HR>
  80. <H1><A NAME="description">DESCRIPTION</A></H1>
  81. <P>This Perl module implements Perl hashes that preserve the order in which the
  82. hash elements were added.  The order is not affected when values
  83. corresponding to existing keys in the IxHash are changed.  The elements can
  84. also be set to any arbitrary supplied order.  The familiar perl array
  85. operations can also be performed on the IxHash.</P>
  86. <P>
  87. <H2><A NAME="standard tiehash interface">Standard <CODE>TIEHASH</CODE> Interface</A></H2>
  88. <P>The standard <CODE>TIEHASH</CODE> mechanism is available. This interface is 
  89. recommended for simple uses, since the usage is exactly the same as
  90. regular Perl hashes after the <A HREF="../../../lib/Pod/perlfunc.html#item_tie"><CODE>tie</CODE></A> is declared.</P>
  91. <P>
  92. <H2><A NAME="object interface">Object Interface</A></H2>
  93. <P>This module also provides an extended object-oriented interface that can be
  94. used for more powerful operations with the IxHash.  The following methods
  95. are available:</P>
  96. <DL>
  97. <DT><STRONG><A NAME="item_FETCH%2C_STORE%2C_DELETE%2C_EXISTS">FETCH, STORE, DELETE, EXISTS</A></STRONG><BR>
  98. <DD>
  99. These standard <CODE>TIEHASH</CODE> methods mandated by Perl can be used directly.
  100. See the <A HREF="../../../lib/Pod/perlfunc.html#item_tie"><CODE>tie</CODE></A> entry in <CODE>perlfunc(1)</CODE> for details.
  101. <P></P>
  102. <DT><STRONG><A NAME="item_Push%2C_Pop%2C_Shift%2C_Unshift%2C_Splice">Push, Pop, Shift, Unshift, Splice</A></STRONG><BR>
  103. <DD>
  104. These additional methods resembling Perl functions are available for
  105. operating on key-value pairs in the IxHash. The behavior is the same as the
  106. corresponding perl functions, except when a supplied hash key already exists
  107. in the hash. In that case, the existing value is updated but its order is
  108. not affected.  To unconditionally alter the order of a supplied key-value
  109. pair, first <CODE>DELETE</CODE> the IxHash element.
  110. <P></P>
  111. <DT><STRONG><A NAME="item_Keys">Keys</A></STRONG><BR>
  112. <DD>
  113. Returns an array of IxHash element keys corresponding to the list of supplied
  114. indices.  Returns an array of all the keys if called without arguments.
  115. Note the return value is mostly only useful when used in a list context
  116. (since perl will convert it to the number of elements in the array when
  117. used in a scalar context, and that may not be very useful).
  118. <P>If a single argument is given, returns the single key corresponding to
  119. the index.  This is usable in either scalar or list context.</P>
  120. <P></P>
  121. <DT><STRONG><A NAME="item_Values">Values</A></STRONG><BR>
  122. <DD>
  123. Returns an array of IxHash element values corresponding to the list of supplied
  124. indices.  Returns an array of all the values if called without arguments.
  125. Note the return value is mostly only useful when used in a list context
  126. (since perl will convert it to the number of elements in the array when
  127. used in a scalar context, and that may not be very useful).
  128. <P>If a single argument is given, returns the single value corresponding to
  129. the index.  This is usable in either scalar or list context.</P>
  130. <P></P>
  131. <DT><STRONG><A NAME="item_Indices">Indices</A></STRONG><BR>
  132. <DD>
  133. Returns an array of indices corresponding to the supplied list of keys.
  134. Note the return value is mostly only useful when used in a list context
  135. (since perl will convert it to the number of elements in the array when
  136. used in a scalar context, and that may not be very useful).
  137. <P>If a single argument is given, returns the single index corresponding to
  138. the key.  This is usable in either scalar or list context.</P>
  139. <P></P>
  140. <DT><STRONG><A NAME="item_Delete">Delete</A></STRONG><BR>
  141. <DD>
  142. Removes elements with the supplied keys from the IxHash.
  143. <P></P>
  144. <DT><STRONG><A NAME="item_Replace">Replace</A></STRONG><BR>
  145. <DD>
  146. Substitutes the IxHash element at the specified index with the supplied
  147. value-key pair.  If a key is not supplied, simply substitutes the value at
  148. index with the supplied value. If an element with the supplied key already
  149. exists, it will be removed from the IxHash first.
  150. <P></P>
  151. <DT><STRONG><A NAME="item_Reorder">Reorder</A></STRONG><BR>
  152. <DD>
  153. This method can be used to manipulate the internal order of the IxHash
  154. elements by supplying a list of keys in the desired order.  Note however,
  155. that any IxHash elements whose keys are not in the list will be removed from
  156. the IxHash.
  157. <P></P>
  158. <DT><STRONG><A NAME="item_Length">Length</A></STRONG><BR>
  159. <DD>
  160. Returns the number of IxHash elements.
  161. <P></P>
  162. <DT><STRONG><A NAME="item_SortByKey">SortByKey</A></STRONG><BR>
  163. <DD>
  164. Reorders the IxHash elements by textual comparison of the keys.
  165. <P></P>
  166. <DT><STRONG><A NAME="item_SortByValue">SortByValue</A></STRONG><BR>
  167. <DD>
  168. Reorders the IxHash elements by textual comparison of the values.
  169. <P></P></DL>
  170. <P>
  171. <HR>
  172. <H1><A NAME="example">EXAMPLE</A></H1>
  173. <PRE>
  174.     use Tie::IxHash;</PRE>
  175. <PRE>
  176.     # simple interface
  177.     $t = tie(%myhash, Tie::IxHash, 'a' => 1, 'b' => 2);
  178.     %myhash = (first => 1, second => 2, third => 3);
  179.     $myhash{fourth} = 4;
  180.     @keys = keys %myhash;
  181.     @values = values %myhash;
  182.     print("y") if exists $myhash{third};
  183. </PRE>
  184. <PRE>
  185.  
  186.     # OO interface
  187.     $t = Tie::IxHash->new(first => 1, second => 2, third => 3);
  188.     $t->Push(fourth => 4); # same as $myhash{'fourth'} = 4;
  189.     ($k, $v) = $t->Pop;    # $k is 'fourth', $v is 4
  190.     $t->Unshift(neg => -1, zeroth => 0); 
  191.     ($k, $v) = $t->Shift;  # $k is 'neg', $v is -1
  192.     @oneandtwo = $t->Splice(1, 2, foo => 100, bar => 101);</PRE>
  193. <PRE>
  194.  
  195.     @keys = $t->Keys;
  196.     @values = $t->Values;
  197.     @indices = $t->Indices('foo', 'zeroth');
  198.     @itemkeys = $t->Keys(@indices);
  199.     @itemvals = $t->Values(@indices);
  200.     $t->Replace(2, 0.3, 'other');
  201.     $t->Delete('second', 'zeroth');
  202.     $len = $t->Length;     # number of key-value pairs</PRE>
  203. <PRE>
  204.     $t->Reorder(reverse @keys);
  205.     $t->SortByKey;
  206.     $t->SortByValue;</PRE>
  207. <P>
  208. <HR>
  209. <H1><A NAME="bugs">BUGS</A></H1>
  210. <P>You cannot specify a negative length to <CODE>Splice</CODE>. Negative indexes are OK,
  211. though.</P>
  212. <P>Indexing always begins at 0 (despite the current <CODE>$[</CODE> setting) for 
  213. all the functions.</P>
  214. <P>
  215. <HR>
  216. <H1><A NAME="todo">TODO</A></H1>
  217. <P>Addition of elements with keys that already exist to the end of the IxHash
  218. must be controlled by a switch.</P>
  219. <P>Provide <CODE>TIEARRAY</CODE> interface when it stabilizes in Perl.</P>
  220. <P>Rewrite using XSUBs for efficiency.</P>
  221. <P>
  222. <HR>
  223. <H1><A NAME="author">AUTHOR</A></H1>
  224. <P>Gurusamy Sarathy        <A HREF="mailto:gsar@umich.edu">gsar@umich.edu</A></P>
  225. <P>Copyright (c) 1995 Gurusamy Sarathy. All rights reserved.
  226. This program is free software; you can redistribute it and/or
  227. modify it under the same terms as Perl itself.</P>
  228. <P>
  229. <HR>
  230. <H1><A NAME="version">VERSION</A></H1>
  231. <P>Version 1.21    20 Nov 1997</P>
  232. <P>
  233. <HR>
  234. <H1><A NAME="see also">SEE ALSO</A></H1>
  235. <P><CODE>perl(1)</CODE></P>
  236. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  237. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  238. <STRONG><P CLASS=block> Tie::IxHash - ordered associative arrays for Perl</P></STRONG>
  239. </TD></TR>
  240. </TABLE>
  241.  
  242. </BODY>
  243.  
  244. </HTML>
  245.