summaryrefslogtreecommitdiff
path: root/doc/html/boost/date_time/nth_kday_of_month.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/date_time/nth_kday_of_month.html')
-rw-r--r--doc/html/boost/date_time/nth_kday_of_month.html38
1 files changed, 19 insertions, 19 deletions
diff --git a/doc/html/boost/date_time/nth_kday_of_month.html b/doc/html/boost/date_time/nth_kday_of_month.html
index 02201d3976..2db5df0253 100644
--- a/doc/html/boost/date_time/nth_kday_of_month.html
+++ b/doc/html/boost/date_time/nth_kday_of_month.html
@@ -47,39 +47,39 @@
<span class="keyword">enum</span> <a name="boost.date_time.nth_kday_of_month.week_num"></a>week_num <span class="special">{</span> first = =1, second, third, fourth, fifth <span class="special">}</span><span class="special">;</span>
<span class="comment">// <a class="link" href="nth_kday_of_month.html#boost.date_time.nth_kday_of_monthconstruct-copy-destruct">construct/copy/destruct</a></span>
- <a class="link" href="nth_kday_of_month.html#id-1_3_12_15_3_19_2_1_3_12-bb"><span class="identifier">nth_kday_of_month</span></a><span class="special">(</span><span class="identifier">week_num</span><span class="special">,</span> <span class="identifier">day_of_week_type</span><span class="special">,</span> <span class="identifier">month_type</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="nth_kday_of_month.html#id-1_3_13_15_3_19_2_1_3_12-bb"><span class="identifier">nth_kday_of_month</span></a><span class="special">(</span><span class="identifier">week_num</span><span class="special">,</span> <span class="identifier">day_of_week_type</span><span class="special">,</span> <span class="identifier">month_type</span><span class="special">)</span><span class="special">;</span>
- <span class="comment">// <a class="link" href="nth_kday_of_month.html#id-1_3_12_15_3_19_2_1_3_11-bb">public member functions</a></span>
- <span class="keyword">virtual</span> <span class="identifier">date_type</span> <a class="link" href="nth_kday_of_month.html#id-1_3_12_15_3_19_2_1_3_11_1-bb"><span class="identifier">get_date</span></a><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="identifier">month_type</span> <a class="link" href="nth_kday_of_month.html#id-1_3_12_15_3_19_2_1_3_11_2-bb"><span class="identifier">month</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="identifier">week_num</span> <a class="link" href="nth_kday_of_month.html#id-1_3_12_15_3_19_2_1_3_11_3-bb"><span class="identifier">nth_week</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="identifier">day_of_week_type</span> <a class="link" href="nth_kday_of_month.html#id-1_3_12_15_3_19_2_1_3_11_4-bb"><span class="identifier">day_of_week</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="nth_kday_of_month.html#id-1_3_12_15_3_19_2_1_3_11_5-bb"><span class="identifier">nth_week_as_str</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="nth_kday_of_month.html#id-1_3_12_15_3_19_2_1_3_11_6-bb"><span class="identifier">to_string</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="comment">// <a class="link" href="nth_kday_of_month.html#id-1_3_13_15_3_19_2_1_3_11-bb">public member functions</a></span>
+ <span class="keyword">virtual</span> <span class="identifier">date_type</span> <a class="link" href="nth_kday_of_month.html#id-1_3_13_15_3_19_2_1_3_11_1-bb"><span class="identifier">get_date</span></a><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="identifier">month_type</span> <a class="link" href="nth_kday_of_month.html#id-1_3_13_15_3_19_2_1_3_11_2-bb"><span class="identifier">month</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="identifier">week_num</span> <a class="link" href="nth_kday_of_month.html#id-1_3_13_15_3_19_2_1_3_11_3-bb"><span class="identifier">nth_week</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="identifier">day_of_week_type</span> <a class="link" href="nth_kday_of_month.html#id-1_3_13_15_3_19_2_1_3_11_4-bb"><span class="identifier">day_of_week</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="nth_kday_of_month.html#id-1_3_13_15_3_19_2_1_3_11_5-bb"><span class="identifier">nth_week_as_str</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="nth_kday_of_month.html#id-1_3_13_15_3_19_2_1_3_11_6-bb"><span class="identifier">to_string</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
-<a name="id-1.3.12.15.3.19.6.4"></a><h2>Description</h2>
+<a name="id-1.3.13.15.3.19.6.4"></a><h2>Description</h2>
<p>Based on the idea in Cal. Calc. for finding holidays that are the 'first Monday of September'. When instantiated with 'fifth' kday of month, the result will be the last kday of month which can be the fourth or fifth depending on the structure of the month.</p>
<p>The algorithm here basically guesses for the first day of the month. Then finds the first day of the correct type. That is, if the first of the month is a Tuesday and it needs Wenesday then we simply increment by a day and then we can add the length of a week until we get to the 'nth kday'. There are probably more efficient algorithms based on using a mod 7, but this one works reasonably well for basic applications. </p>
<div class="refsect2">
-<a name="id-1.3.12.15.3.19.6.4.4"></a><h3>
+<a name="id-1.3.13.15.3.19.6.4.4"></a><h3>
<a name="boost.date_time.nth_kday_of_monthconstruct-copy-destruct"></a><code class="computeroutput">nth_kday_of_month</code>
public
construct/copy/destruct</h3>
-<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="id-1_3_12_15_3_19_2_1_3_12-bb"></a><span class="identifier">nth_kday_of_month</span><span class="special">(</span><span class="identifier">week_num</span> week_no<span class="special">,</span> <span class="identifier">day_of_week_type</span> dow<span class="special">,</span> <span class="identifier">month_type</span> m<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
+<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="id-1_3_13_15_3_19_2_1_3_12-bb"></a><span class="identifier">nth_kday_of_month</span><span class="special">(</span><span class="identifier">week_num</span> week_no<span class="special">,</span> <span class="identifier">day_of_week_type</span> dow<span class="special">,</span> <span class="identifier">month_type</span> m<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
</div>
<div class="refsect2">
-<a name="id-1.3.12.15.3.19.6.4.5"></a><h3>
-<a name="id-1_3_12_15_3_19_2_1_3_11-bb"></a><code class="computeroutput">nth_kday_of_month</code> public member functions</h3>
+<a name="id-1.3.13.15.3.19.6.4.5"></a><h3>
+<a name="id-1_3_13_15_3_19_2_1_3_11-bb"></a><code class="computeroutput">nth_kday_of_month</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
-<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">date_type</span> <a name="id-1_3_12_15_3_19_2_1_3_11_1-bb"></a><span class="identifier">get_date</span><span class="special">(</span><span class="identifier">year_type</span> y<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Return a concrete date when provided with a year specific year. </li>
-<li class="listitem"><pre class="literallayout"><span class="identifier">month_type</span> <a name="id-1_3_12_15_3_19_2_1_3_11_2-bb"></a><span class="identifier">month</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="identifier">week_num</span> <a name="id-1_3_12_15_3_19_2_1_3_11_3-bb"></a><span class="identifier">nth_week</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="identifier">day_of_week_type</span> <a name="id-1_3_12_15_3_19_2_1_3_11_4-bb"></a><span class="identifier">day_of_week</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="id-1_3_12_15_3_19_2_1_3_11_5-bb"></a><span class="identifier">nth_week_as_str</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
+<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">date_type</span> <a name="id-1_3_13_15_3_19_2_1_3_11_1-bb"></a><span class="identifier">get_date</span><span class="special">(</span><span class="identifier">year_type</span> y<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Return a concrete date when provided with a year specific year. </li>
+<li class="listitem"><pre class="literallayout"><span class="identifier">month_type</span> <a name="id-1_3_13_15_3_19_2_1_3_11_2-bb"></a><span class="identifier">month</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="identifier">week_num</span> <a name="id-1_3_13_15_3_19_2_1_3_11_3-bb"></a><span class="identifier">nth_week</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="identifier">day_of_week_type</span> <a name="id-1_3_13_15_3_19_2_1_3_11_4-bb"></a><span class="identifier">day_of_week</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="id-1_3_13_15_3_19_2_1_3_11_5-bb"></a><span class="identifier">nth_week_as_str</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_12_15_3_19_2_1_3_11_6-bb"></a><span class="identifier">to_string</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns string suitable for use in POSIX time zone string. <p>Returns a string formatted as "M4.3.0" ==&gt; 3rd Sunday in April. </p>
+<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_13_15_3_19_2_1_3_11_6-bb"></a><span class="identifier">to_string</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns string suitable for use in POSIX time zone string. <p>Returns a string formatted as "M4.3.0" ==&gt; 3rd Sunday in April. </p>
</li>
</ol></div>
</div>