var searchIndex = {};
searchIndex["hwloc"] = {"doc":"","items":[[3,"TopologySupport","hwloc","",null,null],[3,"TopologyDiscoverySupport","","",null,null],[3,"TopologyCpuBindSupport","","Flags describing actual PU binding support for this topology.",null,null],[3,"TopologyMemBindSupport","","Flags describing actual memory binding support for this topology.",null,null],[3,"TopologyObject","","",null,null],[3,"TopologyObjectMemory","","",null,null],[3,"Topology","","",null,null],[3,"CpuBindFlags","","Process/Thread binding flags.",null,null],[3,"MemBindPolicy","","",null,null],[4,"ObjectType","","Represents the type of a topology object.",null,null],[13,"System","","The whole system that is accessible to hwloc. That may comprise several\nmachines in SSI systems like Kerrighed.",0,null],[13,"Machine","","The typical root object type. A set of processors and memory with cache\ncoherency.",0,null],[13,"NUMANode","","A set of processors around memory which the processors can directly\naccess.",0,null],[13,"Package","","Physical package, what goes into a socket. In the physical meaning,\ni.e. that you can add or remove physically.",0,null],[13,"Cache","","The Cache. Can be L1i, L1d, L2, L3,...",0,null],[13,"Core","","A computation unit (may be shared by several logical processors).",0,null],[13,"PU","","Processing Unit, or (Logical) Processor.",0,null],[13,"Group","","Group objects.",0,null],[13,"Misc","","Miscellaneous objects.",0,null],[13,"Bridge","","Any bridge that connects the host or an I/O bus, to another I/O bus.",0,null],[13,"PCIDevice","","PCI device.",0,null],[13,"OSDevice","","Operating system device.",0,null],[13,"TypeMax","","An internal sentinel value.",0,null],[4,"TypeDepthError","","",null,null],[13,"TypeDepthUnknown","","No object of given type exists in the topology.",1,null],[13,"TypeDepthMultiple","","Objects of given type exist at different depth in the topology.",1,null],[13,"TypeDepthBridge","","Virtual depth for bridge object level.",1,null],[13,"TypeDepthPCIDevice","","Virtual depth for PCI device object level.",1,null],[13,"TypeDepthOSDevice","","Virtual depth for software device object level.",1,null],[13,"UnkownTypeDepthError","","HWLOC returned a depth error which is not known to the rust binding.",1,null],[4,"TopologyFlag","","",null,null],[13,"WholeSystem","","",2,null],[13,"IsThisSystem","","",2,null],[13,"IoDevices","","",2,null],[13,"IoBridges","","",2,null],[13,"WholeIo","","",2,null],[13,"ICaches","","",2,null],[4,"CpuBindError","","",null,null],[13,"Generic","","",3,null],[11,"clone","","",0,null],[11,"fmt","","",0,null],[11,"partial_cmp","","",0,null],[11,"eq","","",0,null],[11,"eq","","",1,null],[11,"fmt","","",1,null],[11,"eq","","",2,null],[11,"fmt","","",2,null],[11,"to_i64","","",2,null],[11,"to_u64","","",2,null],[11,"from_i64","","",2,{"inputs":[{"name":"i64"}],"output":{"name":"option"}}],[11,"from_u64","","",2,{"inputs":[{"name":"u64"}],"output":{"name":"option"}}],[11,"object_type","","The type of the object.",4,null],[11,"memory","","The memory attributes of the object.",4,null],[11,"os_index","","The OS-provided physical index number.",4,null],[11,"name","","The name of the object, if set.",4,null],[11,"depth","","Vertical index in the hierarchy.",4,null],[11,"logical_index","","Horizontal index in the whole list of similar objects, hence guaranteed\nunique across the entire machine.",4,null],[11,"sibling_rank","","This objects index in the parents children list.",4,null],[11,"arity","","The number of direct children.",4,null],[11,"symmetric_subtree","","Set if the subtree of objects below this object is symmetric, which means all\nchildren and their children have identical subtrees.",4,null],[11,"children","","All direct children of this object.",4,null],[11,"next_cousin","","Next object of same type and depth.",4,null],[11,"prev_cousin","","Previous object of same type and depth.",4,null],[11,"first_child","","First child of the next depth.",4,null],[11,"last_child","","Last child of the next depth.",4,null],[11,"parent","","Last child of the next depth.",4,null],[11,"prev_sibling","","Previous object below the same parent.",4,null],[11,"next_sibling","","Next object below the same parent.",4,null],[11,"cpuset","","CPUs covered by this object.",4,null],[11,"complete_cpuset","","The complete CPU set of logical processors of this object.",4,null],[11,"online_cpuset","","The CPU set of online logical processors.",4,null],[11,"allowed_cpuset","","The CPU set of allowed logical processors.",4,null],[11,"nodeset","","NUMA nodes covered by this object or containing this object.",4,null],[11,"complete_nodeset","","The complete NUMA node set of this object,.",4,null],[11,"allowed_nodeset","","The set of allowed NUMA memory nodes.",4,null],[11,"cache_attributes","","",4,null],[11,"fmt","","",4,null],[11,"total_memory","","The total memory (in bytes) in this object and its children.",5,null],[11,"local_memory","","The local memory (in bytes) in this object.",5,null],[11,"fmt","","",6,null],[11,"discovery","","",6,null],[11,"cpu","","",6,null],[11,"memory","","",6,null],[11,"fmt","","",7,null],[11,"pu","","Detecting the number of PU objects is supported.",7,null],[11,"fmt","","",8,null],[11,"set_current_process","","Binding the whole current process is supported.",8,null],[11,"get_current_process","","Getting the binding of the whole current process is supported.",8,null],[11,"set_process","","Binding a whole given process is supported.",8,null],[11,"get_process","","Getting the binding of a whole given process is supported.",8,null],[11,"set_current_thread","","Binding the current thread only is supported.",8,null],[11,"get_current_thread","","Getting the binding of the current thread only is supported.",8,null],[11,"set_thread","","Binding a given thread only is supported.",8,null],[11,"get_thread","","Getting the binding of a given thread only is supported.",8,null],[11,"get_current_process_last_cpu_location","","Getting the last processors where the whole current process ran is supported.",8,null],[11,"get_process_last_cpu_location","","Getting the last processors where a whole process ran is supported.",8,null],[11,"get_current_thread_last_cpu_location","","Getting the last processors where the current thread ran is supported.",8,null],[11,"fmt","","",9,null],[11,"set_current_process","","Binding the whole current process is supported.",9,null],[11,"get_current_process","","Getting the binding of the whole current process is supported.",9,null],[11,"set_process","","Binding a whole given process is supported.",9,null],[11,"get_process","","Getting the binding of a whole given process is supported.",9,null],[11,"set_current_thread","","Binding the current thread only is supported.",9,null],[11,"get_current_thread","","Getting the binding of the current thread only is supported.",9,null],[11,"set_area","","Binding a given memory area is supported.",9,null],[11,"get_area","","Getting the binding of a given memory area is supported.",9,null],[11,"alloc","","Allocating a bound memory area is supported.",9,null],[11,"first_touch","","First-touch policy is supported.",9,null],[11,"bind","","Bind policy is supported.",9,null],[11,"interleave","","Interleave policy is supported.",9,null],[11,"replicate","","Replication policy is supported.",9,null],[11,"next_touch","","Next-touch migration policy is supported.",9,null],[11,"migrate","","Migration flags is supported.",9,null],[6,"CpuSet","","",null,null],[6,"NodeSet","","",null,null],[17,"CPUBIND_PROCESS","","",null,null],[17,"CPUBIND_THREAD","","",null,null],[17,"CPUBIND_STRICT","","",null,null],[17,"CPUBIND_NO_MEMBIND","","",null,null],[17,"MEMBIND_DEFAULT","","",null,null],[17,"MEMBIND_FIRSTTOUCH","","",null,null],[17,"MEMBIND_BIND","","",null,null],[17,"MEMBIND_INTERLEAVE","","",null,null],[17,"MEMBIND_REPLICATE","","",null,null],[17,"MEMBIND_NEXTTOUCH","","",null,null],[17,"MEMBIND_MIXED","","",null,null],[11,"new","","Creates a new Topology.",10,{"inputs":[],"output":{"name":"topology"}}],[11,"with_flags","","Creates a new Topology with custom flags.",10,{"inputs":[{"name":"vec"}],"output":{"name":"topology"}}],[11,"support","","",10,null],[11,"flags","","Returns the flags currently set for this topology.",10,null],[11,"depth","","Returns the full depth of the topology.",10,null],[11,"depth_for_type","","Returns the depth for the given `ObjectType`.",10,null],[11,"depth_or_below_for_type","","",10,null],[11,"depth_or_above_for_type","","",10,null],[11,"type_at_depth","","Returns the corresponding `ObjectType` for the given depth.",10,null],[11,"size_at_depth","","Returns the number of objects at the given depth.",10,null],[11,"object_at_root","","Returns the `TopologyObject` at the root of the topology.",10,null],[11,"type_at_root","","Returns the `ObjectType` at the root of the topology.",10,null],[11,"objects_with_type","","Returns all `TopologyObjects` with the given `ObjectType`.",10,null],[11,"objects_at_depth","","Returns all `TopologyObject`s at the given depth.",10,null],[11,"set_cpubinding","","Bind current process or thread on cpus given in physical bitmap set.",10,null],[11,"set_cpubinding_for_pid","","",10,null],[11,"set_cpubinding_for_thread","","",10,null],[11,"get_cpubinding_for_thread","","",10,null],[11,"get_cpubinding_for_pid","","",10,null],[11,"get_cpubinding","","Get current process or thread binding.",10,null],[11,"get_last_cpu_location","","Get the last physical CPU where the current process or thread ran.",10,null],[11,"drop","","",10,null],[11,"fmt","","",3,null],[11,"hash","","",11,null],[11,"cmp","","",11,null],[11,"partial_cmp","","",11,null],[11,"lt","","",11,null],[11,"le","","",11,null],[11,"gt","","",11,null],[11,"ge","","",11,null],[11,"clone","","",11,null],[11,"eq","","",11,null],[11,"ne","","",11,null],[11,"fmt","","",11,null],[11,"empty","","Returns an empty set of flags.",11,{"inputs":[],"output":{"name":"cpubindflags"}}],[11,"all","","Returns the set containing all flags.",11,{"inputs":[],"output":{"name":"cpubindflags"}}],[11,"bits","","Returns the raw value of the flags currently stored.",11,null],[11,"from_bits","","Convert from underlying bit representation, unless that\nrepresentation contains bits that do not correspond to a flag.",11,{"inputs":[{"name":"i32"}],"output":{"name":"option"}}],[11,"from_bits_truncate","","Convert from underlying bit representation, dropping any bits\nthat do not correspond to flags.",11,{"inputs":[{"name":"i32"}],"output":{"name":"cpubindflags"}}],[11,"is_empty","","Returns `true` if no flags are currently stored.",11,null],[11,"is_all","","Returns `true` if all flags are currently set.",11,null],[11,"intersects","","Returns `true` if there are flags common to both `self` and `other`.",11,null],[11,"contains","","Returns `true` all of the flags in `other` are contained within `self`.",11,null],[11,"insert","","Inserts the specified flags in-place.",11,null],[11,"remove","","Removes the specified flags in-place.",11,null],[11,"toggle","","Toggles the specified flags in-place.",11,null],[11,"bitor","","Returns the union of the two sets of flags.",11,null],[11,"bitxor","","Returns the left flags, but with all the right flags toggled.",11,null],[11,"bitand","","Returns the intersection between the two sets of flags.",11,null],[11,"sub","","Returns the set difference of the two sets of flags.",11,null],[11,"not","","Returns the complement of this set of flags.",11,null],[11,"from_iter","","",11,{"inputs":[{"name":"t"}],"output":{"name":"cpubindflags"}}],[11,"hash","","",12,null],[11,"cmp","","",12,null],[11,"partial_cmp","","",12,null],[11,"lt","","",12,null],[11,"le","","",12,null],[11,"gt","","",12,null],[11,"ge","","",12,null],[11,"clone","","",12,null],[11,"eq","","",12,null],[11,"ne","","",12,null],[11,"fmt","","",12,null],[11,"empty","","Returns an empty set of flags.",12,{"inputs":[],"output":{"name":"membindpolicy"}}],[11,"all","","Returns the set containing all flags.",12,{"inputs":[],"output":{"name":"membindpolicy"}}],[11,"bits","","Returns the raw value of the flags currently stored.",12,null],[11,"from_bits","","Convert from underlying bit representation, unless that\nrepresentation contains bits that do not correspond to a flag.",12,{"inputs":[{"name":"i32"}],"output":{"name":"option"}}],[11,"from_bits_truncate","","Convert from underlying bit representation, dropping any bits\nthat do not correspond to flags.",12,{"inputs":[{"name":"i32"}],"output":{"name":"membindpolicy"}}],[11,"is_empty","","Returns `true` if no flags are currently stored.",12,null],[11,"is_all","","Returns `true` if all flags are currently set.",12,null],[11,"intersects","","Returns `true` if there are flags common to both `self` and `other`.",12,null],[11,"contains","","Returns `true` all of the flags in `other` are contained within `self`.",12,null],[11,"insert","","Inserts the specified flags in-place.",12,null],[11,"remove","","Removes the specified flags in-place.",12,null],[11,"toggle","","Toggles the specified flags in-place.",12,null],[11,"bitor","","Returns the union of the two sets of flags.",12,null],[11,"bitxor","","Returns the left flags, but with all the right flags toggled.",12,null],[11,"bitand","","Returns the intersection between the two sets of flags.",12,null],[11,"sub","","Returns the set difference of the two sets of flags.",12,null],[11,"not","","Returns the complement of this set of flags.",12,null],[11,"from_iter","","",12,{"inputs":[{"name":"t"}],"output":{"name":"membindpolicy"}}]],"paths":[[4,"ObjectType"],[4,"TypeDepthError"],[4,"TopologyFlag"],[4,"CpuBindError"],[3,"TopologyObject"],[3,"TopologyObjectMemory"],[3,"TopologySupport"],[3,"TopologyDiscoverySupport"],[3,"TopologyCpuBindSupport"],[3,"TopologyMemBindSupport"],[3,"Topology"],[3,"CpuBindFlags"],[3,"MemBindPolicy"]]};
initSearch(searchIndex);