endplay v0.5.12 documentation

These are the documentation pages for the Python package endplay. Most of the information can also be found in the README.md file in the github repo, but is presented here broken down into sections along with some extra information pages and a comprehensive API reference of all the modules and packages the library exposes.

Main Contents:

• What is endplay?
• Building and installing
  • From PyPI
  • From source
  • For development
  • Building the documentation
  • Running the test suite
• Overview of submodules
• Tutorial
  • Inspecting deals
    • Enumerated types
    • The interact module
  • Generating hands
    • The main module
  • Evaluating hands
    • Assigning point values to hands
    • Evaluating shape
  • Double dummy analysis
    • Analyse
    • DD Tables
    • Par contract calculation and scoring contracts
    • Bids and auctions: an aside
    • Solving for a player’s hand
  • Parsing to and from bridge file formats (PBN, LIN, JSON)
• Dealer Scripts
  • Basic Layout
  • Lexical structure
  • Inputs
  • Expressions
  • Actions
  • An example
• API Documentation
  • endplay._dds
    • endplay._dds.libdds
    • AnalyseAllPlaysBin()
    • AnalyseAllPlaysPBN()
    • AnalysePlayBin()
    • AnalysePlayPBN()
    • CalcAllTables()
    • CalcAllTablesPBN()
    • CalcDDtable()
    • CalcDDtablePBN()
    • CalcPar()
    • CalcParPBN()
    • ConvertToDealerTextFormat()
    • ConvertToSidesTextFormat()
    • DDSError
    • DDSInfo
    • DealerPar()
    • DealerParBin()
    • ErrorMessage()
    • FreeMemory()
    • Par()
    • SetMaxThreads()
    • SidesPar()
    • SidesParBin()
    • SolveAllBoards()
    • SolveAllBoardsBin()
    • SolveAllChunks()
    • SolveAllChunksBin()
    • SolveAllChunksPBN()
    • SolveBoard()
    • SolveBoardPBN()
    • allParResults
    • boards
    • boardsPBN
    • contractType
    • ddTableDeal
    • ddTableDealPBN
    • ddTableDeals
    • ddTableDealsPBN
    • ddTableResults
    • ddTablesRes
    • deal
    • dealPBN
    • futureTricks
    • parResults
    • parResultsDealer
    • parResultsMaster
    • parTextResults
    • playTraceBin
    • playTracePBN
    • playTracesBin
    • playTracesPBN
    • solvedBoards
    • solvedPlay
    • solvedPlays
  • endplay.dds
    • endplay.dds.analyse
    • endplay.dds.ddtable
    • endplay.dds.parscore
    • endplay.dds.solve
    • analyse_all_plays()
    • analyse_all_starts()
    • analyse_play()
    • analyse_start()
    • calc_all_tables()
    • calc_dd_table()
    • par()
    • solve_all_boards()
    • solve_board()
  • endplay.dealer
    • endplay.dealer.actions
    • endplay.dealer.__main__
    • endplay.dealer.constraint
    • endplay.dealer.generate
    • endplay.dealer.runscript
    • generate_deal()
    • generate_deals()
    • run_script()
  • endplay.evaluate
    • bergen_hcp_scale
    • cccc()
    • controls()
    • dist_points()
    • exact_shape()
    • hcp()
    • is_balanced()
    • is_minor_semibalanced()
    • is_semibalanced()
    • is_single_suited()
    • is_three_suited()
    • is_two_suited()
    • length_dist_scale
    • losers()
    • major_shape()
    • minor_shape()
    • mixed_fit_dist_scale
    • mixed_nofit_dist_scale
    • quality()
    • rule_of_n()
    • shape()
    • shortage_fit_dist_scale
    • shortage_nofit_dist_scale
    • standard_hcp_scale
    • top_honours()
    • total_points()
  • endplay.experimental
    • endplay.experimental.playdetect
  • endplay.interact
    • endplay.interact.frontends
    • endplay.interact.__main__
    • endplay.interact.actions
    • endplay.interact.commandobject
  • endplay.parsers
    • endplay.parsers.dealer
    • endplay.parsers.json
    • endplay.parsers.lin
    • endplay.parsers.pbn
  • endplay.stats
    • average()
    • cofrequency()
    • frequency()
  • endplay.types
    • endplay.types.bid
    • endplay.types.board
    • endplay.types.card
    • endplay.types.contract
    • endplay.types.deal
    • endplay.types.denom
    • endplay.types.hand
    • endplay.types.penalty
    • endplay.types.player
    • endplay.types.rank
    • endplay.types.suitholding
    • endplay.types.vul
    • AlternateRank
    • Bid
    • Board
    • Card
    • Contract
    • ContractBid
    • Deal
    • Denom
    • Hand
    • Penalty
    • PenaltyBid
    • Player
    • Rank
    • SuitHolding
    • Vul
  • endplay.utils
    • endplay.utils.escape
    • endplay.utils.io
    • endplay.utils.play
  • endplay.config
    • suppress_unicode
    • use_unicode