1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
.TH ACE_Stats_Value 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Stats_Value \- Helper class for \fBACE_Stats\fR.
.SH SYNOPSIS
.br
.PP
\fC#include <Stats.h>\fR
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBACE_Stats_Value\fR (const u_int precision)"
.br
.ti -1c
.RI "u_int \fBprecision\fR (void) const"
.br
.RI "\fIAccessor for precision.\fR"
.ti -1c
.RI "void \fBwhole\fR (const ACE_UINT32)"
.br
.RI "\fISet the whole_ field.\fR"
.ti -1c
.RI "ACE_UINT32 \fBwhole\fR (void) const"
.br
.RI "\fIAccessor for the whole_ field.\fR"
.ti -1c
.RI "void \fBfractional\fR (const ACE_UINT32)"
.br
.RI "\fISet the fractional_ field.\fR"
.ti -1c
.RI "ACE_UINT32 \fBfractional\fR (void) const"
.br
.RI "\fIAccessor for the fractional_ field.\fR"
.ti -1c
.RI "ACE_UINT32 \fBfractional_field\fR (void) const"
.br
.RI "\fICalculates the maximum value of the fractional portion, given its precision.\fR"
.ti -1c
.RI "void \fBscaled_value\fR (\fBACE_UINT64\fR &) const"
.br
.ti -1c
.RI "void \fBdump\fR (void) const"
.br
.RI "\fIPrint to stdout.\fR"
.in -1c
.SS Private Methods
.in +1c
.ti -1c
.RI "\fBACE_Stats_Value\fR (void)"
.br
.in -1c
.SS Private Attributes
.in +1c
.ti -1c
.RI "ACE_UINT32 \fBwhole_\fR"
.br
.RI "\fIThe integer portion of the value.\fR"
.ti -1c
.RI "ACE_UINT32 \fBfractional_\fR"
.br
.RI "\fIThe fractional portion of the value.\fR"
.ti -1c
.RI "u_int \fBprecision_\fR"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP
Helper class for \fBACE_Stats\fR.
.PP
.PP
Container struct for 64-bit signed quantity and its precision. It would be nicer to use a fixed-point class, but this is sufficient. Users typically don't need to use this class directly; see \fBACE_Stats\fR below.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS ACE_Stats_Value::ACE_Stats_Value (const u_int precision)
.PP
Constructor, which requires precision in terms of number of decimal digits. The more variation in the data, and the greater the data values, the smaller the precision must be to avoid overflow in the standard deviation calculation. 3 might be a good value, or maybe 4. 5 will probably be too large for non-trivial data sets.
.SS ACE_Stats_Value::ACE_Stats_Value (void)\fC [private]\fR
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS void ACE_Stats_Value::dump (void) const
.PP
Print to stdout.
.PP
.SS ACE_UINT32 ACE_Stats_Value::fractional (void) const
.PP
Accessor for the fractional_ field.
.PP
.SS void ACE_Stats_Value::fractional (const ACE_UINT32)
.PP
Set the fractional_ field.
.PP
.SS ACE_UINT32 ACE_Stats_Value::fractional_field (void) const
.PP
Calculates the maximum value of the fractional portion, given its precision.
.PP
.SS u_int ACE_Stats_Value::precision (void) const
.PP
Accessor for precision.
.PP
.SS void ACE_Stats_Value::scaled_value (\fBACE_UINT64\fR &) const
.PP
Access the value as an _unsigned_ 64 bit quantity. It scales the value up by <precision> decimal digits, so that no precision will be lost. It assumes that <whole_> is >= 0.
.SS ACE_UINT32 ACE_Stats_Value::whole (void) const
.PP
Accessor for the whole_ field.
.PP
.SS void ACE_Stats_Value::whole (const ACE_UINT32)
.PP
Set the whole_ field.
.PP
.SH MEMBER DATA DOCUMENTATION
.PP
.SS ACE_UINT32 ACE_Stats_Value::fractional_\fC [private]\fR
.PP
The fractional portion of the value.
.PP
.SS u_int ACE_Stats_Value::precision_\fC [private]\fR
.PP
The number of decimal digits of precision represented by <fractional_>. Not declared const, so the only way to change it is via the assignment operator.
.SS ACE_UINT32 ACE_Stats_Value::whole_\fC [private]\fR
.PP
The integer portion of the value.
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|
