pike.git/ src/ program.c

Branch: Tag:

2010-05-19

2010-05-19 09:32:22 by Henrik Grubbström (Grubba) <grubba@grubba.org>

Some autodoc updates regarding hash functions.

Rev: src/builtin_functions.c:1.700
Rev: src/program.c:1.777

2:   || This file is part of Pike. For copyright information see COPYRIGHT.   || Pike is distributed under GPL, LGPL and MPL. See the file COPYING   || for more information. - || $Id: program.c,v 1.776 2010/04/10 14:07:30 mast Exp $ + || $Id: program.c,v 1.777 2010/05/19 09:32:22 grubba Exp $   */      #include "global.h"
795:    *!    *! Hashing callback.    *! -  *! This function gets called by various mapping operations when the -  *! object is used as index in a mapping. It should return an -  *! integer that corresponds to the object in such a way that all -  *! values which @[lfun::`==] considers equal to the object gets the -  *! same hash value. +  *! The main caller of this function is @[predef::hash_value()] +  *! or the low-level equvivalent, which get called by various +  *! mapping operations when the object is used as index in a mapping.    *! -  +  *! @returns +  *! It should return an integer that corresponds to the object +  *! in such a way that all values which @[lfun::`==] considers +  *! equal to the object get the same hash value. +  *!    *! @note    *! The function @[predef::hash] does not return hash values that    *! are compatible with this one.
809:    *! It's assumed that this function is side-effect free.    *!    *! @seealso -  *! @[lfun::`==] +  *! @[lfun::`==], @[predef::hash_value()]    */      /*! @decl mixed lfun::cast(string requested_type)