X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=doc%2Fdev%2Fconcepts.texi;h=ed7f44d061d9deec6dc8bd45dcd8377bf697e37f;hb=b7f672dd5f58c5891d7845871a13f20240eb9edf;hp=8d1e8ac0663604ba526332fa7c9bcf8653955f8e;hpb=b401615e6db40bf74394839b96600afe3a868a95;p=pspp diff --git a/doc/dev/concepts.texi b/doc/dev/concepts.texi index 8d1e8ac066..ed7f44d061 100644 --- a/doc/dev/concepts.texi +++ b/doc/dev/concepts.texi @@ -1,3 +1,13 @@ +@c PSPP - a program for statistical analysis. +@c Copyright (C) 2019 Free Software Foundation, Inc. +@c Permission is granted to copy, distribute and/or modify this document +@c under the terms of the GNU Free Documentation License, Version 1.3 +@c or any later version published by the Free Software Foundation; +@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +@c A copy of the license is included in the section entitled "GNU +@c Free Documentation License". +@c + @node Basic Concepts @chapter Basic Concepts @@ -156,27 +166,6 @@ This function returns false if @func{value_init} and @func{value_destroy} are actually required for the given @var{width}. @end deftypefun -@deftypefun double value_num (const union value *@var{value}) -Returns the numeric value in @var{value}, which must have been -initialized as a numeric value. Equivalent to @code{@var{value}->f}. -@end deftypefun - -@deftypefun {const char *} value_str (const union value *@var{value}, int @var{width}) -@deftypefunx {char *} value_str_rw (union value *@var{value}, int @var{width}) -Returns the string value in @var{value}, which must have been -initialized with positive width @var{width}. The string returned is -not null-terminated. Only @var{width} bytes of returned data may be -accessed. - -The two different functions exist only for @code{const}-correctness. -Otherwise they are identical. - -It is important that @var{width} be the correct value that was passed -to @func{value_init}. Passing a smaller or larger value (e.g.@: -because that number of bytes will be accessed) will not always work -and should be avoided. -@end deftypefun - @deftypefun void value_copy (union value *@var{dst}, @ const union value *@var{src}, @ int @var{width}) @@ -609,7 +598,7 @@ Destroys @var{style}, freeing its storage. @end deftypefun @deftypefun {struct fmt_number_style} *fmt_create (void) -A function which creates an array of all the styles used by pspp, and +A function which creates an array of all the styles used by pspp, and calls fmt_number_style_init on each of them. @end deftypefun @@ -698,7 +687,7 @@ This function is declared in @file{data/data-in.h}. @deftypefunx char * data_out_legacy (const union value *@var{input}, const char *@var{encoding}, const struct fmt_spec *@var{format}) Converts the data pointed to by @var{input} into a string value, which will be encoded in UTF-8, according to output format specifier @var{format}. -Format +Format must be a valid output format. The width of @var{input} is inferred from @var{format} using an algorithm equivalent to @func{fmt_var_width}. @@ -1356,7 +1345,7 @@ Looks for a label for @var{value} in @var{var}'s set of value labels. @var{value} must have the same width as @var{var}. If a label exists, it will be appended to the string pointed to by @var{str}. Otherwise, it formats @var{value} -using @var{var}'s print format (@pxref{Input and Output Formats}) +using @var{var}'s print format (@pxref{Input and Output Formats}) and appends the formatted string. @end deftypefun @@ -2026,7 +2015,7 @@ Returns the variable at the given @var{position} in @var{dict}. (see below). @end deftypefun -@deftypefun size_t dict_get_var_cnt (const struct dictionary *@var{dict}) +@deftypefun size_t dict_get_n_vars (const struct dictionary *@var{dict}) Returns the number of variables in @var{dict}. @end deftypefun @@ -2195,7 +2184,7 @@ current name. Renames each of the @var{count} variables in @var{vars} to the name in the corresponding position of @var{new_names}. If the renaming would result in a duplicate variable name, returns false and stores one of -the names that would be be duplicated into @code{*@var{err_name}}, if +the names that would be duplicated into @code{*@var{err_name}}, if @var{err_name} is non-null. Otherwise, the renaming is successful, and true is returned. @end deftypefun @@ -2309,7 +2298,7 @@ only if there are no split variables, returns a null pointer. The caller must not modify or free the returned array. @end deftypefun -@deftypefun size_t dict_get_split_cnt (const struct dictionary *@var{dict}) +@deftypefun size_t dict_get_n_splits (const struct dictionary *@var{dict}) Returns the number of split variables. @end deftypefun @@ -2404,7 +2393,7 @@ call to one of this function in a @func{msg_disable}/@func{msg_enable} pair. @end deftypefun -@deftypefun size_t dict_get_document_line_cnt (const struct dictionary *@var{dict}) +@deftypefun size_t dict_get_document_n_lines (const struct dictionary *@var{dict}) Returns the number of line of documents in @var{dict}. If the dictionary contains no documents, returns 0. @end deftypefun