1
|
<html><head><meta http-equiv="content-type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="dddoc_html.css" type="text/css" /><title>resize</title></head><body><table id=main_table cellspacing=0 cellpadding=0><tr><td valign=top><iframe frameborder=0 id=navigation src="INDEX_Function_Input_2f_Output.html#resize"></iframe></td><td valign=top><div id=content><div class=page_category>Function</div><div class=page_title>resize</div><div id=summary><div class=text>Resizes a container. If the new length exceeds the old length the new elements are filled with copies of <span class=code><nobr>value</nobr></span>.</div></div><div class=section id=signature><div class=signature_block><nobr><span class=code><nobr>resize(file, new_length)</nobr></span></nobr></div><div class=signature_block><nobr><span class=code><nobr>Size resize(object, newLength [value], [resizeTag])</nobr></span></nobr></div></div><div class=section id=include><div class=section_headline>Include Headers</div><div class=text_block>seqan/file.h, seqan/sequence.h</div></div><div class=section id=param><div class=section_headline>Parameters</div><table class=value_tab cellspacing=0 cellpadding=0><tr><td class=value_key valign=top><nobr>file</nobr></td><td class=value_text valign=top><div class=text_sub_block> A File object.</div><div class=text_sub_block><span class=section_sub_headline>Types:</span> <a href="CLASS_File.html" title="Represents a file." >File</a></div></td></tr><tr><td class=value_key valign=top><nobr>new_length</nobr></td><td class=value_text valign=top><div class=text_sub_block> The new file size measured in bytes.</div></td></tr><tr><td class=value_key valign=top><nobr>object</nobr></td><td class=value_text valign=top><div class=text_sub_block> A container.</div><div class=text_sub_block><span class=section_sub_headline>Types:</span> <a href="ADAPTION.char+array.html" title="Zero terminated char[] or wchar_t[]." >char array</a>, <a href="CLASS_Pool.html" title="Pools are push- and pop-passive pipeline modules." >Pool</a>, <a href="CLASS_Segment.html" title="A contiguous part of a sequence." >Segment</a>, <a href="SPEC_Simple_Shape.html" title="A variable length ungapped shape (also called q-gram or k-mer)." >SimpleShape</a>, <a href="ADAPTION.std_3a_3abasic__string.html" title="Adaption for STL strings." >std::basic_string</a>, <a href="ADAPTION.std_3a_3avector.html" title="Adaption for STL vector class." >std::vector</a>, <a href="CLASS_String.html" title="General purpose container for sequences." >String</a>, <a href="CLASS_String.html" title="General purpose container for sequences." >String</a>, <a href="CLASS_String_Set.html" title="A container class for a set of strings." >StringSet</a></div></td></tr><tr><td class=value_key valign=top><nobr>newLength</nobr></td><td class=value_text valign=top><div class=text_sub_block> The new length <span class=code><nobr>object</nobr></span> will get.</div></td></tr><tr><td class=value_key valign=top><nobr>value</nobr></td><td class=value_text valign=top><div class=text_sub_block> Value that is copied if new items are created in <span class=code><nobr>object</nobr></span>.</div><div class=text_sub_block><span class=section_sub_headline>Remarks:</span> If the <span class=code><nobr>value</nobr></span> argument is omitted, the items are not initialized.</div></td></tr><tr><td class=value_key valign=top><nobr>resizeTag</nobr></td><td class=value_text valign=top><div class=text_sub_block> Specifies the strategy that is applied if the capacity of <span class=code><nobr>object</nobr></span> is less than <span class=code><nobr>newLength</nobr></span>. (optional)</div><div class=text_sub_block><span class=section_sub_headline>Types:</span> <a href="TAG_Overflow+_Strategy.html" title="The strategy for resizing containers." >Overflow Strategy</a></div><div class=text_sub_block><span class=section_sub_headline>Default:</span> Specified by <a href="METAFUNCTION_Default_Overflow_Explicit.html" title="The default overflow strategy for explicit resize." >DefaultOverflowExplicit</a>.</div></td></tr></table></div><div class=section id=remarks><div class=section_headline>Remarks</div><div class=text_block><div class=text_sub_block> This function can be used both for expanding and for shrinking <span class=code><nobr>object</nobr></span>.</div></div></div><div class=section id=returns><div class=section_headline>Return Values</div><div class=text_block><div class=text_sub_block> The new length <span class=code><nobr>length(object)</nobr></span>.</div><div class=text_sub_block><span class=section_sub_headline>Metafunctions:</span> <a href="METAFUNCTION_Size.html" title="Type of an object that is suitable to hold size information." >Size</a></div></div></div><div class="section" id="see"><div class="section_headline">See Also</div><div class="text_block"><span class="link_text"><a href="FUNCTION.length.html" title="The number of items/characters." >length</a></span>, <span class="link_text"><a href="FUNCTION.clear.html" title="Resets an object." >clear</a></span>, <span class="link_text"><a href="FUNCTION.reserve.html" title="Increases the capacity." >reserve</a></span></div></div><div class=page_footline>SeqAn - Sequence Analysis Library - <a href="http://www.seqan.de">www.seqan.de</a></div><div id=page_widthblock> </div></div></td></tr></table><p style="font-size:50%; color: #909090">Page built @2012/03/14 16:34:48</p></body></html>
|
