1"use strict";(self.webpackChunkais_package_github_io=self.webpackChunkais_package_github_io||[]).push([[2685],{28453:(e,t,s)=>{s.d(t,{R:()=>l,x:()=>d});var r=s(96540);const n={},i=r.createContext(n);function l(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(i.Provider,{value:t},e.children)}},85567:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>l,metadata:()=>r,toc:()=>o});const r=JSON.parse('{"id":"api/utils/display/progress-table","title":"ProgressTable","description":"Display a formatted table in the console to track the algorithm\'s progress.","source":"@site/versioned_docs/version-0.5.x/api/utils/display/progress-table.md","sourceDirName":"api/utils/display","slug":"/api/utils/display/progress-table","permalink":"/docs/api/utils/display/progress-table","draft":false,"unlisted":false,"tags":[],"version":"0.5.x","lastUpdatedBy":"Jo\xe3o Paulo","lastUpdatedAt":1781982648000,"frontMatter":{"id":"progress-table","sidebar_label":"ProgressTable"},"sidebar":"api","previous":{"title":"ProgressBar","permalink":"/docs/api/utils/display/progress-bar"},"next":{"title":"TableFormatter","permalink":"/docs/api/utils/display/table-formatter"}}');var n=s(74848),i=s(28453);const l={id:"progress-table",sidebar_label:"ProgressTable"},d="ProgressTable",a={},o=[{value:"Constructor Parameters",id:"constructor-parameters",level:2},{value:"Public Methods",id:"public-methods",level:2},{value:"update",id:"update",level:3},{value:"finish",id:"finish",level:3}];function c(e){const t={a:"a",admonition:"admonition",blockquote:"blockquote",br:"br",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"progresstable",children:"ProgressTable"})}),"\n",(0,n.jsx)(t.p,{children:"Display a formatted table in the console to track the algorithm's progress."}),"\n",(0,n.jsx)(t.admonition,{title:"Inheritance",type:"tip",children:(0,n.jsxs)(t.p,{children:["This class extends ",(0,n.jsx)(t.a,{href:"/docs/api/utils/display/table-formatter",children:"TableFormatter"}),"."]})}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Module:"})," ",(0,n.jsx)(t.code,{children:"aisp.utils.display"}),(0,n.jsx)(t.br,{}),"\n",(0,n.jsx)(t.strong,{children:"Import:"})," ",(0,n.jsx)(t.code,{children:"from aisp.utils.display import ProgressTable"})]}),"\n"]}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h2,{id:"constructor-parameters",children:"Constructor Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Name"}),(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Default"}),(0,n.jsx)(t.th,{children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"headers"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"Mapping[str, int]"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"-"}),(0,n.jsxs)(t.td,{children:["Mapping ",(0,n.jsx)(t.code,{children:"{column_name: column_width}"}),"."]})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"verbose"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"bool"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.code,{children:"True"})}),(0,n.jsx)(t.td,{children:"If False, prints nothing to the terminal."})]})]})]}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h2,{id:"public-methods",children:"Public Methods"}),"\n",(0,n.jsx)(t.h3,{id:"update",children:"update"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-python",children:"def update(self, values: Mapping[str, Union[str, int, float]]) -> None:\n ...\n"})}),"\n",(0,n.jsx)(t.p,{children:"Add a new row of values to the table."}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.strong,{children:"Parameters"})}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Name"}),(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Default"}),(0,n.jsx)(t.th,{children:"Description"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"values"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"Mapping[str, Union[str, int, float]]"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"-"}),(0,n.jsx)(t.td,{children:"Keys must match the columns defined in headers."})]})})]}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"finish",children:"finish"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-python",children:"def finish(self) -> None:\n ...\n"})}),"\n",(0,n.jsx)(t.p,{children:"End the table display, printing the bottom border and total time."})]})}function h(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.