info > Bit::Vector::String

man perldoc info pydoc3 ri search

📖 NAME

Bit::Vector::String - Generic string import/export for Bit::Vector

🚀 Quick Reference

Use Case	Command	Description
Export vector as octal string	$vector->to_Oct()	Returns octal string (no prefix)
Import octal string into vector	$vector->from_Oct($string)	Reads octal string (no prefix)
Create new vector from octal string	Bit::Vector->new_Oct($bits,$string)	Constructor + initialize from octal
Export in any format	$vector->String_Export($type)	Returns string with identifying prefix
Import string with auto‑detect format	$vector->String_Import($string)	Reads string, returns format number
Create new vector with auto‑detect format	Bit::Vector->new_String($bits,$string)	Constructor + import, auto‑sizes if $bits is undef

📝 SYNOPSIS

use Bit::Vector::String;

to_Oct
    $string = $vector->to_Oct();

from_Oct
    $vector->from_Oct($string);

new_Oct
    $vector = Bit::Vector->new_Oct($bits,$string);

String_Export
    $string = $vector->String_Export($type);

String_Import
    $type = $vector->String_Import($string);

new_String
    $vector = Bit::Vector->new_String($bits,$string);
    ($vector,$type) = Bit::Vector->new_String($bits,$string);

📚 DESCRIPTION

• $string = $vector->to_Oct();
  🔸 Returns an octal string representing the given bit vector.
  ⚠️ Not particularly efficient – about 40× slower than to_Bin().
  🔸 Since an octal digit equals three bits, the string length is always a multiple of three bits.
  🔸 LEAST significant digit is at the RIGHT end, MOST significant at the LEFT end.
  🔸 Does NOT prepend any format prefix (e.g., 0o). Add it manually if needed: $string = '0o' . $vector->to_Oct();
• $vector->from_Oct($string);
  🔸 Reads an octal string into the bit vector.
  ⚠️ Inefficient – about 40× slower than from_Bin().
  🔸 String must contain only digits [0-7]; no prefix like 0o allowed.
  🔸 If string is too short, remaining bits are cleared (set to zero). If too long, extra characters are ignored.
  🔸 Least significant bits are on the right.
• $vector = Bit::Vector->new_Oct($bits,$string);
  🔸 Alternative constructor: creates a new bit vector and initializes it from an octal string.
  🔸 Internally calls new() then from_Oct().
  🔸 If $bits is undef, automatically allocates 3 * length($string) bits.
  🔸 Throws fatal error if memory allocation fails or string is invalid.
• $string = $vector->String_Export($type);
  🔸 Returns a string in the format specified by $type:
  1 | b | bin → binary (0b prefix)
  2 | o | oct → octal (0o prefix)
  3 | d | dec → decimal (no prefix, sign is prefix)
  4 | h | hex | x → hexadecimal (0x prefix)
  5 | e | enum → enumeration ({...} wrapper)
  6 | p | pack → packed binary (:size:data)
  🔸 Case is ignored. If $type is omitted/undef/false, defaults to hexadecimal.
  🔸 Prefixes are added to avoid ambiguity between formats.
• $type = $vector->String_Import($string);
  🔸 Imports a string into the bit vector, auto‑detecting the format.
  🔸 Tries to match in order: binary, octal, decimal, hexadecimal, enumeration, packed binary.
  🔸 Returns the format number (1-6) on success.
  🔸 For unambiguous results, supply a prefix (e.g., 0b for binary).
• $vector = Bit::Vector->new_String($bits,$string);
($vector,$type) = Bit::Vector->new_String($bits,$string);
  🔸 Alternative constructor: creates a new vector and imports a string with auto‑detect.
  🔸 If $bits is undef, automatically calculates required bits based on format:
  binary → length($string)
octal → 3 * length($string)
decimal → int(length($string) * log(10)/log(2) + 1)
hexadecimal → 4 * length($string)
enumeration → max value + 1
  packed binary → extracted from :size: prefix
  🔸 In scalar context returns the vector; in list context also returns the format number.

🔗 SEE ALSO

Bit::Vector(3), Bit::Vector::Overload(3).

🏷️ VERSION

This man page documents Bit::Vector::String version 7.4.

👤 AUTHOR

Steffen Beyer
mailto:<STBEY AT cpan.org>
http://www.engelschall.com/u/sb/download/

© COPYRIGHT

Copyright (c) 2004 - 2013 by Steffen Beyer. All rights reserved.

📜 LICENSE

This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself, i.e., under the terms of the "Artistic License" or the "GNU General Public License".

The C library at the core of this Perl module can additionally be redistributed and/or modified under the terms of the "GNU Library General Public License".

Please refer to the files Artistic.txt, GNU_GPL.txt and GNU_LGPL.txt in this distribution for details!

⚠️ DISCLAIMER

This package is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the "GNU General Public License" for more details.

📖 NAME 🚀 Quick Reference 📝 SYNOPSIS 📚 DESCRIPTION 🔗 SEE ALSO 🏷️ VERSION 👤 AUTHOR © COPYRIGHT 📜 LICENSE ⚠️ DISCLAIMER