diff options
Diffstat (limited to 'storage/xtradb/include/rem0cmp.ic')
| -rw-r--r-- | storage/xtradb/include/rem0cmp.ic | 53 |
1 files changed, 26 insertions, 27 deletions
diff --git a/storage/xtradb/include/rem0cmp.ic b/storage/xtradb/include/rem0cmp.ic index 1abf4142531..d5185ec94af 100644 --- a/storage/xtradb/include/rem0cmp.ic +++ b/storage/xtradb/include/rem0cmp.ic @@ -16,44 +16,44 @@ Place, Suite 330, Boston, MA 02111-1307 USA *****************************************************************************/ -/*********************************************************************** +/*******************************************************************//** +@file include/rem0cmp.ic Comparison services for records Created 7/1/1994 Heikki Tuuri ************************************************************************/ -/***************************************************************** +/*************************************************************//** This function is used to compare two data fields for which we know the -data type. */ +data type. +@return 1, 0, -1, if data1 is greater, equal, less than data2, respectively */ UNIV_INLINE int cmp_data_data( /*==========*/ - /* out: 1, 0, -1, if data1 is greater, equal, - less than data2, respectively */ - ulint mtype, /* in: main type */ - ulint prtype, /* in: precise type */ - const byte* data1, /* in: data field (== a pointer to a memory + ulint mtype, /*!< in: main type */ + ulint prtype, /*!< in: precise type */ + const byte* data1, /*!< in: data field (== a pointer to a memory buffer) */ - ulint len1, /* in: data field length or UNIV_SQL_NULL */ - const byte* data2, /* in: data field (== a pointer to a memory + ulint len1, /*!< in: data field length or UNIV_SQL_NULL */ + const byte* data2, /*!< in: data field (== a pointer to a memory buffer) */ - ulint len2) /* in: data field length or UNIV_SQL_NULL */ + ulint len2) /*!< in: data field length or UNIV_SQL_NULL */ { return(cmp_data_data_slow(mtype, prtype, data1, len1, data2, len2)); } -/***************************************************************** +/*************************************************************//** This function is used to compare two dfields where at least the first -has its data type field set. */ +has its data type field set. +@return 1, 0, -1, if dfield1 is greater, equal, less than dfield2, +respectively */ UNIV_INLINE int cmp_dfield_dfield( /*==============*/ - /* out: 1, 0, -1, if dfield1 is greater, equal, - less than dfield2, respectively */ - const dfield_t* dfield1,/* in: data field; must have type field set */ - const dfield_t* dfield2)/* in: data field */ + const dfield_t* dfield1,/*!< in: data field; must have type field set */ + const dfield_t* dfield2)/*!< in: data field */ { const dtype_t* type; @@ -68,21 +68,20 @@ cmp_dfield_dfield( dfield_get_len(dfield2))); } -/***************************************************************** +/*************************************************************//** This function is used to compare two physical records. Only the common -first fields are compared. */ +first fields are compared. +@return 1, 0 , -1 if rec1 is greater, equal, less, respectively, than +rec2; only the common first fields are compared */ UNIV_INLINE int cmp_rec_rec( /*========*/ - /* out: 1, 0 , -1 if rec1 is greater, equal, - less, respectively, than rec2; only the common - first fields are compared */ - const rec_t* rec1, /* in: physical record */ - const rec_t* rec2, /* in: physical record */ - const ulint* offsets1,/* in: rec_get_offsets(rec1, index) */ - const ulint* offsets2,/* in: rec_get_offsets(rec2, index) */ - dict_index_t* index) /* in: data dictionary index */ + const rec_t* rec1, /*!< in: physical record */ + const rec_t* rec2, /*!< in: physical record */ + const ulint* offsets1,/*!< in: rec_get_offsets(rec1, index) */ + const ulint* offsets2,/*!< in: rec_get_offsets(rec2, index) */ + dict_index_t* index) /*!< in: data dictionary index */ { ulint match_f = 0; ulint match_b = 0; |