IDOL Keyview Filter SDK 12.5 C++ Programming Guide

Total Page:16

File Type:pdf, Size:1020Kb

IDOL Keyview Filter SDK 12.5 C++ Programming Guide KeyView Software Version 12.5 Filter SDK C++ Programming Guide Document Release Date: February 2020 Software Release Date: February 2020 Filter SDK C++ Programming Guide Legal notices Copyright notice © Copyright 2016-2020 Micro Focus or one of its affiliates. The only warranties for products and services of Micro Focus and its affiliates and licensors (“Micro Focus”) are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Micro Focus shall not be liable for technical or editorial errors or omissions contained herein. The information contained herein is subject to change without notice. Documentation updates The title page of this document contains the following identifying information: l Software Version number, which indicates the software version. l Document Release Date, which changes each time the document is updated. l Software Release Date, which indicates the release date of this version of the software. To check for updated documentation, visit https://www.microfocus.com/support-and-services/documentation/. Support Visit the MySupport portal to access contact information and details about the products, services, and support that Micro Focus offers. This portal also provides customer self-solve capabilities. It gives you a fast and efficient way to access interactive technical support tools needed to manage your business. As a valued support customer, you can benefit by using the MySupport portal to: l Search for knowledge documents of interest l Access product documentation l View software vulnerability alerts l Enter into discussions with other software customers l Download software patches l Manage software licenses, downloads, and support contracts l Submit and track service requests l Contact customer support l View information about all services that Support offers Many areas of the portal require you to sign in. If you need an account, you can create one when prompted to sign in. To learn about the different access levels the portal uses, see the Access Levels descriptions. KeyView (12.5) Page 2 of 250 Filter SDK C++ Programming Guide Contents Part I: Overview of Filter SDK 11 Chapter 1: Introducing Filter SDK 12 Overview 12 Features 12 Platforms, Compilers, and Dependencies 13 Supported Platforms 13 Supported Compilers 14 C++ Filter SDK 14 Software Dependencies 14 Windows Installation 15 UNIX Installation 16 Package Contents 17 License Information 18 Enable Advanced Document Readers 18 Update License Information 18 Directory Structure 19 Chapter 2: Getting Started 22 Use the C++ Language Implementation of the API 22 Build the C++ API 22 Create a KeyView Session 23 Configure your session 23 Detect the Format of a File 24 Filter a File 24 Extract Subfiles 24 Extract Metadata 25 Exceptions 25 Generic IO Types 25 Part II: Use Filter SDK 28 Chapter 3: Use the File Extraction API 29 Introduction 29 Extract Subfiles 30 Extract Images 31 Extract Mail Metadata 31 Default Metadata Set 31 Extract the Default Metadata Set 32 Extract Subfiles from Outlook Express Files 32 Extract Subfiles from Mailbox Files 32 Extract Subfiles from Outlook Personal Folders Files 33 Choose the Reader to use for PST Files 33 KeyView (12.5) Page 3 of 250 Filter SDK C++ Programming Guide MAPI Attachment Methods 35 Open Secured PST Files 35 Detect PST Files While the Outlook Client is Running 35 Extract Subfiles from Lotus Domino XML Language Files 36 Extract .DXL Files to HTML 36 Extract Subfiles from Lotus Notes Database Files 37 System Requirements 37 Installation and Configuration 37 Windows 38 Solaris 38 AIX 5.x 38 Linux 39 Open Secured NSF Files 39 Format Note Subfiles 39 Extract Subfiles from PDF Files 40 Improve Performance for PDFs with Many Small Images 40 Extract Embedded OLE Objects 40 Extract Subfiles from ZIP Files 41 Extract Metadata 41 Chapter 4: Use the Filter API 42 Generate an Error Log 42 Enable or Disable Error Logging 43 Use the API 43 Use Environment Variables 43 Change the Path and File Name of the Log File 43 Report Memory Errors 43 Use the API 44 Use Environment Variables 44 Specify a Memory Guard 44 Specify the Maximum Size of the Log File 44 Extract Metadata 45 Convert Character Sets 45 Determine the Character Set of the Output Text 45 Guidelines for Character Set Conversion 46 Set the Character Set During Filtering 46 Set the Character Set During Subfile Extraction 47 Extract Deleted Text Marked by Tracked Changes 47 Filter a File 47 Filter PDF Files 48 Filter PDF Files to a Logical Reading Order 48 Enable Logical Reading Order 49 Use the C++ API 49 Use the formats.ini File 49 Rotated Text 50 Extract Custom Metadata from PDF Files 50 Extract All Custom Metadata 50 KeyView (12.5) Page 4 of 250 Filter SDK C++ Programming Guide Filter Tagged PDF Content 50 Skip Embedded Fonts 51 Use the formats.ini File 51 Use the C++ API 51 Control Hyphenation 52 Use the formats.ini File 52 Use the C++ API 52 Filter Portfolio PDF Files 52 Filter Spreadsheet Files 52 Filter Worksheet Names 52 Filter Hidden Text in Microsoft Excel Files 53 Specify Date and Time Format on UNIX Systems 53 Filter Very Large Numbers in Spreadsheet Cells to Precision Numbers 53 Extract Microsoft Excel Formulas 54 Configure Headers and Footers 55 Filter Hidden Data 56 Hidden Data in HTML Documents 56 Tab Delimited Output for Embedded Tables 56 Table Detection for PDF Files 57 Exclude Japanese Guide Text 57 Source Code Identification 57 Chapter 5: Sample Programs 60 Introduction 60 Build the Sample Programs 60 Run the Sample Programs 61 detect 61 extract 62 filter_document 62 metadata 63 subfiles 63 filter_container 63 Part III: C++ API Reference 64 Chapter 7: InputTypes and OutputTypes 66 Chapter 8: The keyview Namespace 68 The Session Class 68 Constructor 68 config 69 detect 69 filter 69 get_summary_information 69 metadata_map 70 subfiles 70 The Configuration Class 70 Constructor 70 KeyView (12.5) Page 5 of 250 Filter SDK C++ Programming Guide custom_pdf_metadata 70 date_time_field_codes 71 extraction_timeout 71 filename_field_code 71 formatted_mail 71 header_and_footer 72 header_and_footer_tags 72 hidden_text 72 no_encoding_conversion 72 out_of_process_log 73 out_of_process_memory_log 73 password 73 pdf_logical_reading 73 revision_marks 74 skip_comments 74 skip_embedded_fonts 74 skip_thumbnail 74 soft_hyphens 75 source_encoding 75 tagged_pdf_content 75 target_encoding 75 string& temporary_directory 76 timeout 76 unicode_byte_order_marker 76 The DetectionInfo Class 76 appleDoubleEncoded 77 appleSingleEncoded 77 category 77 category_name 77 description 77 encrypted 77 extension 78 format 78 macBinaryEncoded 78 version 78 wangGDLencoded 78 windowRMSEncrypted 79 The Container Class 79 The Subfile Class 79 extract 79 children 79 index 80 is_folder 80 mail_metadata 80 parent 80 rawname 80 KeyView (12.5) Page 6 of 250 Filter SDK C++ Programming Guide size 81 time 81 type 81 The SummaryInfoItem Class 81 apply_visitor 82 convert_to_string 82 name 82 type 82 The SummaryInfoVisitorBase Class 82 visit_boolean 83 visit_datetime 83 visit_double 83 visit_integer 83 visit_target_encoding_string 84 visit_utf8_string 84 Enumerations 84 LogicalPDFDirection 85 SubFile::Type 85 SummaryInfoType 86 Exceptions 86 Chapter 9: The keyview::io Namespace 88 InputFile 88 Constructors 88 OutputFile 88 Constructors 88 OutputStdout 88 Constructors 89 InMemoryFile 89 Constructors 89 Appendixes 90 Appendix A: Supported Formats 91 Key to Supported Formats Table 91 Supported Formats 93 Appendix B: Document Readers 154 Key to Document Reader Tables 154 Archive Formats 155 Binary Format 158 Computer-Aided Design Formats 159 Database Formats 160 Desktop Publishing 161 Display Formats 161 Graphic Formats 162 Mail Formats 166 Multimedia Formats 169 KeyView (12.5) Page 7 of 250 Filter SDK C++ Programming Guide Presentation Formats 172 Spreadsheet Formats 175 Text and Markup Formats 177 Word Processing Formats 178 Appendix C: Character Sets 184 Multibyte and Bidirectional Support 184 Coded Character Sets 192 Appendix D: Extract and Format Lotus Notes Subfiles 198 Overview 198 Customize XML Templates 198 Use Demo Templates 199 Use Old Templates 199 Disable XML Templates 199 Template Elements and Attributes 200 Conditional Elements 200 Control Elements 201 Data Elements 202 Date and Time Formats 205 Lotus Notes Date and Time Formats 205 KeyView Date and Time Formats 206 Appendix E: File Format Detection 211 Introduction 211 Extract Format Information 211 Determine Format Support 211 Example formats.ini file entries 212 Refine Detection of Text Files 212 Allow Consecutive NULL Bytes in a Text File 213 Translate Format Information 214 Distinguish Between Formats 214 Determine a Document Reader 215 Category Values in formats.ini 215 Appendix F: List of Required Files for Redistribution 219 Core Files 219 Support Files 220 Document Readers 221 Appendix G: Develop a Custom Reader 228 Introduction 228 How to Write a Custom Reader 229 Naming Conventions 229 Basic Steps 230 Token Buffer 230 Macros 231 Reader Interface 232 Function Flow 232 Example Development of fffFillBuffer() 233 KeyView (12.5) Page 8 of 250 Filter SDK C++ Programming Guide Implementation 1—fpFillBuffer() Function 233 Structure of Implementation 1 234 Problems with Implementation 1 234 Implementation 2—Processing a Large Token Stream 235 Structure of Implementation 2 236 Problems with Implementation 2 236 Boundary Conditions 236 Implementation 3—Interrupting Structured Access Layer Calls 237 Structure of Implementation 3 239 Development Tips 239 Functions 240 xxxsrAutoDet() 240 xxxAllocateContext() 241 xxxFreeContext() 242 xxxInitDoc() 243 xxxFillBuffer() 243 xxxGetSummaryInfo() 244 xxxOpenStream() 245 xxxCloseStream() 246 xxxCharSet() 246 Appendix H: Password Protected Files 248 Supported Password Protected File Types 248 Send documentation feedback 250 KeyView (12.5) Page 9 of 250 Filter SDK C++ Programming Guide KeyView (12.5) Page 10 of 250 Part I: Overview of Filter SDK This section provides an overview of the Micro Focus KeyView Filter SDK and describes how to use the C++ implementation of the API. KeyView (12.5) Page 11 of 250 Chapter 1: Introducing Filter SDK This section describes the Filter SDK package.
Recommended publications
  • Lecture 04 Linear Structures Sort
    Algorithmics (6EAP) MTAT.03.238 Linear structures, sorting, searching, etc Jaak Vilo 2018 Fall Jaak Vilo 1 Big-Oh notation classes Class Informal Intuition Analogy f(n) ∈ ο ( g(n) ) f is dominated by g Strictly below < f(n) ∈ O( g(n) ) Bounded from above Upper bound ≤ f(n) ∈ Θ( g(n) ) Bounded from “equal to” = above and below f(n) ∈ Ω( g(n) ) Bounded from below Lower bound ≥ f(n) ∈ ω( g(n) ) f dominates g Strictly above > Conclusions • Algorithm complexity deals with the behavior in the long-term – worst case -- typical – average case -- quite hard – best case -- bogus, cheating • In practice, long-term sometimes not necessary – E.g. for sorting 20 elements, you dont need fancy algorithms… Linear, sequential, ordered, list … Memory, disk, tape etc – is an ordered sequentially addressed media. Physical ordered list ~ array • Memory /address/ – Garbage collection • Files (character/byte list/lines in text file,…) • Disk – Disk fragmentation Linear data structures: Arrays • Array • Hashed array tree • Bidirectional map • Heightmap • Bit array • Lookup table • Bit field • Matrix • Bitboard • Parallel array • Bitmap • Sorted array • Circular buffer • Sparse array • Control table • Sparse matrix • Image • Iliffe vector • Dynamic array • Variable-length array • Gap buffer Linear data structures: Lists • Doubly linked list • Array list • Xor linked list • Linked list • Zipper • Self-organizing list • Doubly connected edge • Skip list list • Unrolled linked list • Difference list • VList Lists: Array 0 1 size MAX_SIZE-1 3 6 7 5 2 L = int[MAX_SIZE]
    [Show full text]
  • Programmatic Testing of the Standard Template Library Containers
    Programmatic Testing of the Standard Template Library Containers y z Jason McDonald Daniel Ho man Paul Stro op er May 11, 1998 Abstract In 1968, McIlroy prop osed a software industry based on reusable comp onents, serv- ing roughly the same role that chips do in the hardware industry. After 30 years, McIlroy's vision is b ecoming a reality. In particular, the C++ Standard Template Library STL is an ANSI standard and is b eing shipp ed with C++ compilers. While considerable attention has b een given to techniques for developing comp onents, little is known ab out testing these comp onents. This pap er describ es an STL conformance test suite currently under development. Test suites for all of the STL containers have b een written, demonstrating the feasi- bility of thorough and highly automated testing of industrial comp onent libraries. We describ e a ordable test suites that provide go o d co de and b oundary value coverage, including the thousands of cases that naturally o ccur from combinations of b oundary values. We showhowtwo simple oracles can provide fully automated output checking for all the containers. We re ne the traditional categories of black-b ox and white-b ox testing to sp eci cation-based, implementation-based and implementation-dep endent testing, and showhow these three categories highlight the key cost/thoroughness trade- o s. 1 Intro duction Our testing fo cuses on container classes |those providing sets, queues, trees, etc.|rather than on graphical user interface classes. Our approach is based on programmatic testing where the number of inputs is typically very large and b oth the input generation and output checking are under program control.
    [Show full text]
  • Parallelization of Bulk Operations for STL Dictionaries
    Parallelization of Bulk Operations for STL Dictionaries Leonor Frias1?, Johannes Singler2 [email protected], [email protected] 1 Dep. de Llenguatges i Sistemes Inform`atics,Universitat Polit`ecnicade Catalunya 2 Institut f¨urTheoretische Informatik, Universit¨atKarlsruhe Abstract. STL dictionaries like map and set are commonly used in C++ programs. We consider parallelizing two of their bulk operations, namely the construction from many elements, and the insertion of many elements at a time. Practical algorithms are proposed for these tasks. The implementation is completely generic and engineered to provide best performance for the variety of possible input characteristics. It features transparent integration into the STL. This can make programs profit in an easy way from multi-core processing power. The performance mea- surements show the practical usefulness on real-world multi-core ma- chines with up to eight cores. 1 Introduction Multi-core processors bring parallel computing power to the customer at virtu- ally no cost. Where automatic parallelization fails and OpenMP loop paralleliza- tion primitives are not strong enough, parallelized algorithms from a library are a sensible choice. Our group pursues this goal with the Multi-Core Standard Template Library [6], a parallel implementation of the C++ STL. To allow best benefit from the parallel computing power, as many operations as possible need to be parallelized. Sequential parts could otherwise severely limit the achievable speedup, according to Amdahl’s law. Thus, it may be profitable to parallelize an operation even if the speedup is considerably less than the number of threads. The STL contains four kinds of generic dictionary types, namely set, map, multiset, and multimap.
    [Show full text]
  • FORSCHUNGSZENTRUM JÜLICH Gmbh Programming in C++ Part II
    FORSCHUNGSZENTRUM JÜLICH GmbH Jülich Supercomputing Centre D-52425 Jülich, Tel. (02461) 61-6402 Ausbildung von Mathematisch-Technischen Software-Entwicklern Programming in C++ Part II Bernd Mohr FZJ-JSC-BHB-0155 1. Auflage (letzte Änderung: 19.09.2003) Copyright-Notiz °c Copyright 2008 by Forschungszentrum Jülich GmbH, Jülich Supercomputing Centre (JSC). Alle Rechte vorbehalten. Kein Teil dieses Werkes darf in irgendeiner Form ohne schriftliche Genehmigung des JSC reproduziert oder unter Verwendung elektronischer Systeme verarbeitet, vervielfältigt oder verbreitet werden. Publikationen des JSC stehen in druckbaren Formaten (PDF auf dem WWW-Server des Forschungszentrums unter der URL: <http://www.fz-juelich.de/jsc/files/docs/> zur Ver- fügung. Eine Übersicht über alle Publikationen des JSC erhalten Sie unter der URL: <http://www.fz-juelich.de/jsc/docs> . Beratung Tel: +49 2461 61 -nnnn Auskunft, Nutzer-Management (Dispatch) Das Dispatch befindet sich am Haupteingang des JSC, Gebäude 16.4, und ist telefonisch erreich- bar von Montag bis Donnerstag 8.00 - 17.00 Uhr Freitag 8.00 - 16.00 Uhr Tel.5642oder6400, Fax2810, E-Mail: [email protected] Supercomputer-Beratung Tel. 2828, E-Mail: [email protected] Netzwerk-Beratung, IT-Sicherheit Tel. 6440, E-Mail: [email protected] Rufbereitschaft Außerhalb der Arbeitszeiten (montags bis donnerstags: 17.00 - 24.00 Uhr, freitags: 16.00 - 24.00 Uhr, samstags: 8.00 - 17.00 Uhr) können Sie dringende Probleme der Rufbereitschaft melden: Rufbereitschaft Rechnerbetrieb: Tel. 6400 Rufbereitschaft Netzwerke: Tel. 6440 An Sonn- und Feiertagen gibt es keine Rufbereitschaft. Fachberater Tel. +49 2461 61 -nnnn Fachgebiet Berater Telefon E-Mail Auskunft, Nutzer-Management, E.
    [Show full text]
  • Getting to the Root of Concurrent Binary Search Tree Performance
    Getting to the Root of Concurrent Binary Search Tree Performance Maya Arbel-Raviv, Technion; Trevor Brown, IST Austria; Adam Morrison, Tel Aviv University https://www.usenix.org/conference/atc18/presentation/arbel-raviv This paper is included in the Proceedings of the 2018 USENIX Annual Technical Conference (USENIX ATC ’18). July 11–13, 2018 • Boston, MA, USA ISBN 978-1-939133-02-1 Open access to the Proceedings of the 2018 USENIX Annual Technical Conference is sponsored by USENIX. Getting to the Root of Concurrent Binary Search Tree Performance Maya Arbel-Raviv Trevor Brown Adam Morrison Technion IST Austria Tel Aviv University Abstract reason about data structure performance. Given that real- Many systems rely on optimistic concurrent search trees life search tree workloads operate on trees with millions for multi-core scalability. In principle, optimistic trees of items and do not suffer from high contention [3, 26, 35], have a simple performance story: searches are read-only it is natural to assume that search performance will be and so run in parallel, with writes to shared memory oc- a dominating factor. (After all, most of the time will be curring only when modifying the data structure. However, spent searching the tree, with synchronization—if any— this paper shows that in practice, obtaining the full perfor- happening only at the end of a search.) In particular, we mance benefits of optimistic search trees is not so simple. would expect two trees with similar structure (and thus We focus on optimistic binary search trees (BSTs) similar-length search paths), such as balanced trees with and perform a detailed performance analysis of 10 state- logarithmic height, to perform similarly.
    [Show full text]
  • Jt-Polys-Cours-11.Pdf
    Notes de cours Standard Template Library ' $ ' $ Ecole Nationale d’Ing´enieurs de Brest Table des mati`eres L’approche STL ................................... 3 Les it´erateurs .................................... 15 Les classes de fonctions .......................... 42 Programmation par objets Les conteneurs ................................... 66 Le langage C++ Les adaptateurs ................................. 134 — Standard Template Library — Les algorithmes g´en´eriques ...................... 145 Index ........................................... 316 J. Tisseau R´ef´erences ...................................... 342 – 1996/1997 – enib c jt ........ 1/344 enib c jt ........ 2/344 & % & % Standard Template Library L’approche STL ' $ ' $ L’approche STL Biblioth`eque de composants C++ g´en´eriques L’approche STL Fonctions : algorithmes g´en´eriques 1. Une biblioth`eque de composants C++ g´en´eriques sort, binary search, reverse, for each, accumulate,... 2. Du particulier au g´en´erique Conteneurs : collections homog`enes d’objets 3. Des indices aux it´erateurs, via les pointeurs vector, list, set, map, multimap,... 4. De la g´en´ericit´edes donn´ees `ala g´en´ericit´edes structures It´erateurs : sorte de pointeurs pour inspecter un conteneur input iterator, random access iterator, ostream iterator,... Objets fonction : encapsulation de fonctions dans des objets plus, times, less equal, logical or,... Adaptateurs : modificateurs d’interfaces de composants stack, queue, priority queue,... enib c jt ........ 3/344 enib c jt ........ 4/344 & % & % L’approche STL L’approche STL ' $ ' $ Du particulier . au g´en´erique int template <class T> max(int x, int y) { return x < y? y : x; } const T& max(const T& x, const T& y) { return x < y? y : x; } int template <class T, class Compare> max(int x, int y, int (*compare)(int,int)) { const T& return compare(x,y)? y : x; max(const T& x, const T& y, Compare compare) { } return compare(x, y)? y : x; } enib c jt .......
    [Show full text]
  • C++ STL Container Map Multimap Hash Map Hash Multimap
    MODULE 29 --THE STL-- CONTAINER PART III map, multimap, hash_map, hash_multimap, hash_set, hash_multiset My Training Period: hours Note: Compiled using VC++7.0 / .Net, win32 empty console mode application. Be careful with the source codes than span more than one line. g++ compilation examples are given at the end of this Module. Abilities ▪ Able to understand and use map associative container. ▪ Able to understand and use multimap associative container. ▪ Able to understand and use hash_map associative container. ▪ Able to understand and use hash_multimap associative container. ▪ Able to understand and use hash_set associative container. ▪ Able to understand and use hash_multiset container. ▪ Remember some useful summary. 29.1 map - A map contains elements that are key and value pairs. Each element has a key that is the basis for the sorting criterion and a value. - Each key may occur only once, thus duplicate keys are not allowed. - A map can also be used as an associative array, which is an array that has an arbitrary index type. It can be depicted as follow: - The binary tree of the map and multimap structure can be depicted as follow: - The iterator provided by the map class is a bidirectional iterator, but the class member functions insert() and map() have versions that take as template parameters a weaker input iterator, whose functionality requirements are more minimal than those guaranteed by the class of bidirectional iterators. - The different iterator concepts form a family related by refinements in their functionality. Each iterator concept has its own set of requirements and the algorithms that work with them must limit their assumptions to the requirements provided by that type of iterator.
    [Show full text]
  • Algorithms and Data Structures in C++ Complexity Analysis
    Algorithms and Data Structures in C++ Complexity analysis Answers the question “How does the time needed for an algorithm scale with the problem size N?”" !Worst case analysis: maximum time needed over all possible inputs" !Best case analysis: minimum time needed" !Average case analysis: average time needed" !Amortized analysis: average over a sequence of operations" !Usually only worst-case information is given since average case is much harder to estimate." The O notation !Is used for worst case analysis:# # An algorithm is O(f (N)) if there are constants c and N0, such that for N≥ N0 the time to perform the algorithm for an input size N is bounded by t(N) < c f(N)" !Consequences " !O(f(N)) is identically the same as O(a f(N)) !O(a Nx + b Ny) is identically the same as O(Nmax(x,y))" !O(Nx) implies O(Ny) for all y ≥ x Notations !W is used for best case analysis:# # An algorithm is W(f (N)) if there are constants c and N0, such that for N≥ N0 the time to perform the algorithm for an input size N is bounded by t(N) > c f(N)" !Q is used if worst and best case scale the same# # An algorithm is Q(f (N)) if it is W(f (N)) and O(f (N)) " Time assuming 1 billion operations per second Complexity" N=10" 102" 103" 104" 105" 106" 1" 1 ns" 1 ns" 1 ns" 1 ns" 1 ns" 1ns" ln N" 3 ns" 7 ns" 10 ns" 13 ns" 17 ns" 20 ns" N" 10 ns" 100 ns" 1 µs" 10 µs" 100 µs" 1 ms" N log N" 33 ns" 664 ns" 10 µs" 133 µs" 1.7 ms" 20 ms" N2" 100 ns" 10 µs" 1 ms" 100 ms" 10 s" 17 min" N3" 1 µs" 1 ms" 1 s" 17 min" 11.5 d" 31 a" 2N" 1 µs" 1014 a" 10285 a" 102996 a" 1030086 a"
    [Show full text]
  • The C++ Standard Template Library
    The C++ Standard Template Library Douglas C. Schmidt Professor Department of EECS [email protected] Vanderbilt University www.dre.vanderbilt.edu/∼schmidt/ (615) 343-8197 February 12, 2014 The C++ STL Douglas C. Schmidt The C++ Standard Template Library • What is STL? • Generic Programming: Why Use STL? • Overview of STL concepts & features – e.g., helper class & function templates, containers, iterators, generic algorithms, function objects, adaptors • A Complete STL Example • References for More Information on STL Vanderbilt University 1 The C++ STL Douglas C. Schmidt What is STL? The Standard Template Library provides a set of well structured generic C++ components that work together in a seamless way. –Alexander Stepanov & Meng Lee, The Standard Template Library Vanderbilt University 2 The C++ STL Douglas C. Schmidt What is STL (cont’d)? • A collection of composable class & function templates – Helper class & function templates: operators, pair – Container & iterator class templates – Generic algorithms that operate over iterators – Function objects – Adaptors • Enables generic programming in C++ – Each generic algorithm can operate over any iterator for which the necessary operations are provided – Extensible: can support new algorithms, containers, iterators Vanderbilt University 3 The C++ STL Douglas C. Schmidt Generic Programming: Why Use STL? • Reuse: “write less, do more” – STL hides complex, tedious & error prone details – The programmer can then focus on the problem at hand – Type-safe plug compatibility between STL
    [Show full text]
  • University of Waterloo CS240E, Winter 2021 Assignment 4 Due Date: Wednesday, Mar 24, 2021 at 5Pm
    University of Waterloo CS240E, Winter 2021 Assignment 4 Due Date: Wednesday, Mar 24, 2021 at 5pm The integrity of the grade you receive in this course is very important to you and the University of Waterloo. As part of every assessment in this course you must read and sign an Academic Integrity Declaration (AID) before you start working on the assessment and submit it before the deadline of March 24th along with your answers to the assignment; i.e. read, sign and submit A04-AID.txt now or as soon as possible. The agreement will indicate what you must do to ensure the integrity of your grade. If you are having difficulties with the assignment, course staff are there to help (provided it isn't last minute). The Academic Integrity Declaration must be signed and submitted on time or the assessment will not be marked. Please read http://www.student.cs.uwaterloo.ca/~cs240e/w21/guidelines/guidelines. pdf for guidelines on submission. Each written question solution must be submit- ted individually to MarkUs as a PDF with the corresponding file names: a4q1.pdf, a4q2.pdf, ... , a4q6.pdf. It is a good idea to submit questions as you go so you aren't trying to create sev- eral PDF files at the last minute. Remember, late assignments will not be marked but can be submitted to MarkUs after the deadline for feedback if you email [email protected] and let the ISAs know to look for it. 1. (6 marks) A MultiMap is an ADT that allows to store multiple values associated with keys.
    [Show full text]
  • Why You Shouldn't Use Set (And What You Should Use Instead) Matt Austern
    Why you shouldn't use set (and what you should use instead) Matt Austern Everything in the standard C++ library is there for a reason, but it isn't always obvious what that reason is. The standard isn't a tutorial; it doesn't distinguish between basic, everyday components and ones that are there only for rare and specialized purposes. One example is the Associative Container std::set (and its siblings map, multiset, and multimap). Sometimes it does make sense to use a set, but not as often as you might think. The standard library provides other tools for storing and looking up data, and often you can do just as well with a simpler, smaller, faster data structure. What is a set? A set is an STL container that stores values and permits easy lookup. For example, you might have a set of strings: std::set<std::string> S; You can add a new element by writing S.insert("foo";. A set may not contain more than one element with the same key, so insert won't add anything if S already contains the string "foo"; instead it just looks up the old element. The return value includes a status code indicating whether or not the new element got inserted. As with all STL containers, you can step through all of the elements in a set using the set's iterators. S.begin() returns an iterator that points to S's first element, and S.end() returns an iterator that points immediately after S's last element. The elements of a set are always sorted in ascending order-which is why insert doesn't have an argument telling it where the new element is supposed to be put.
    [Show full text]
  • Standard Template Library Outline
    C++ Standard Template Library Fall 2013 Yanjun Li CS2200 1 Outline • Standard Template Library • Containers & Iterators • STL vector • STL list • STL stack • STL queue Fall 2013 Yanjun Li CS2200 2 Software Engineering Observation • Avoid reinventing the wheel; program with the reusable components of the C++ Standard Library. Fall 2013 Yanjun Li CS2200 3 Standard Template Library • The Standard Library is a fundamental part of the C++ Standard. – a comprehensive set of efficiently implemented tools and facilities. • Standard Template Library (STL), which is the most important section of the Standard Library. Fall 2013 Yanjun Li CS2200 4 Standard Template Library (STL) • Defines powerful, template-based, reusable components and algorithms to process them – Implement many common data structures • Conceived and designed for performance and flexibility • Three key components – Containers – Iterators – Algorithms Fall 2013 Yanjun Li CS2200 5 STL Containers • A container is an object that represents a group of elements of a certain type, stored in a way that depends on the type of container (i.e., array, linked list, etc.). • STL container: a generic type of container – the operations and element manipulations are identical regardless the type of underlying container that you are using. Fall 2013 Yanjun Li CS2200 6 Fall 2013 Yanjun Li CS2200 7 STL Containers • Type requirements for STL container elements – Elements must be copied to be inserted in a container • Element’s type must provide copy constructor and assignment operator • Compiler will provide default memberwise copy and default memberwise assignment, which may or may not be appropriate – Elements might need to be compared • Element’s type should provide equality operator and less- than operator Fall 2013 Yanjun Li CS2200 8 Iterators • An iterator is a pointer-like object that is able to "point" to a specific element in the container.
    [Show full text]