Component models ================ Use ``component(Model)`` when a part of your problem already has its own quantities and relationships. The parent can use those quantities directly; observations on either side can determine unknowns on the other. This guide develops the second step of :doc:`getting-started`. Reuse a smaller model --------------------- A parcel's diagonal depends on its base diagonal. Keep the base relationship in a triangle model and reuse it: >>> from sympy import sqrt >>> from modello import InstanceDummy, Modello, component >>> class Triangle(Modello): ... a = InstanceDummy("a", positive=True) ... b = InstanceDummy("b", positive=True) ... c = sqrt(a**2 + b**2) >>> class Box(Modello): ... base = component(Triangle) ... height = InstanceDummy("height", positive=True) ... diagonal = sqrt(base.c**2 + height**2) >>> parcel = Box("parcel", base=Triangle("base", a=3, b=4), height=12) >>> parcel.base.c, parcel.diagonal (5, 13) ``parcel.base`` is a ``Triangle`` instance. Component paths such as ``base.c`` let you express relationships across the whole model. You can also supply nested quantities and whole components directly using their dotted paths. Put them in a dictionary and pass it with Python's ``**`` syntax: >>> direct = Box("direct", height=12, **{"base.a": 3, "base.b": 4}) >>> direct.base.c, direct.diagonal (5, 13) Infer a quantity inside a component ----------------------------------- Supply exactly 13 units of diagonal clearance, rather than the base width: >>> partial_base = Triangle("base", b=4) >>> inferred = Box("width", base=partial_base, height=12, diagonal=13) >>> inferred.base.a, inferred.base.c (3, 5) The parent and child equations are solved together. The supplied component remains available for other questions; completing this parcel does not change it: >>> bool(partial_base.a.free_symbols) True Omitting a component leaves its quantities unknown. Reusing a partial instance in several components gives each its own unknowns unless you connect them. Connect quantities in different children ---------------------------------------- Suppose two openings need braces of the same length. A parent can equate their diagonals while each child keeps its own relationship between sides and length: >>> class LinkedBraces(Modello): ... first = component(Triangle) ... second = component(Triangle) ... ... length = first.c ... length = second.c >>> linked = LinkedBraces( ... "shared", first=Triangle("first", a=3, b=4), second=Triangle("second", b=3) ... ) >>> linked.first.c, linked.second.c, linked.second.a (5, 5, 4) The first ``length`` assignment names the existing ``first.c`` quantity. Assigning ``length`` again adds the link to ``second.c``: ``length = first.c`` **AND** ``length = second.c``. Both component equations remain in the joint model. An observation of ``length`` can therefore constrain either child. Openings that require different brace lengths give an empty solution family: >>> from modello import inspect_model >>> conflict = inspect_model( ... LinkedBraces, "different_lengths", first=Triangle("first", a=3, b=4), ... second=Triangle("second", a=6, b=8), ... ) >>> conflict.solutions().is_empty True Components can contain further components; the same attribute-path syntax works at each level. These assignments belong in the model class body; assigning an attribute on a solved instance does not add a relationship or recalculate it. Use the same model for new observations --------------------------------------- Construct a new case to change measurements. Changing an attribute on a solved instance does not recalculate dependent quantities. Use :doc:`solutions` when you want to retain alternatives and add information to the same question. Next, :doc:`vectors` covers collections of scalar observations, and :doc:`model-vectors` covers collections whose entries are complete models. The :doc:`API reference ` describes inheritance, copying, and methods.