mf_all.hlp

是一个经济学管理应用软件 很难找的 但是经济学学生又必须用到

{smcl}
{* 28mar2005}{...}
{cmd:help mata all()}
{hline}
{* index all()}{...}
{* index any()}{...}
{* index allof()}{...}
{* index anyof()}{...}

{title:Title}

{p 4 8 2}
{bf:[M-5] all() -- Element comparisons}


{title:Syntax}

{p 8 8 2}
{it:real scalar} {cmd:all(}{it:real matrix L}{cmd:)}

{p 8 8 2}
{it:real scalar} {cmd:any(}{it:real matrix L}{cmd:)}


{p 8 8 2}
{it:real scalar}
{cmd:allof(}{it:transmorphic matrix P}{cmd:,}
{it:transmorphic scalar s}{cmd:)}

{p 8 8 2}
{it:real scalar}
{cmd:anyof(}{it:transmorphic matrix P}{cmd:,}
{it:transmorphic scalar s}{cmd:)}
 

{title:Description}

{p 4 4 2}
{cmd:all(}{it:L}{cmd:)} is equivalent to
{cmd:sum(!}{it:L}{cmd:)==0}, but is significantly faster.

{p 4 4 2}
{cmd:any(}{it:L}{cmd:)} is equivalent to 
{cmd:sum(}{it:L}{cmd:)!=0}, but
is slightly faster.

{p 4 4 2}
{cmd:allof(}{it:P}{cmd:,} {it:s}{cmd:)} returns 1 if every element of {it:P}
equals {it:s} and returns 0 otherwise.
{cmd:allof(}{it:P}{cmd:,} {it:s}{cmd:)} is faster and consumes less memory
than the equivalent construction {cmd:all(}{it:P}{cmd::==}{it:s}{cmd:)}.

{p 4 4 2}
{cmd:anyof(}{it:P}{cmd:,} {it:s}{cmd:)} returns 1 if any element of {it:P}
equals {it:s} and returns 0 otherwise.
{cmd:anyof(}{it:P}{cmd:,} {it:s}{cmd:)} is faster and consumes less memory
than the equivalent 
{cmd:any(}{it:P}{cmd::==}{it:s}{cmd:)}.


{title:Remarks}

{p 4 4 2}
These functions are fast, so their use is encouraged over alternative
constructions.  

{p 4 4 2}
{cmd:all()} and {cmd:any()} are typically used with logical expressions
to detect special cases, such as 

	{cmd:if (any(x :< 0)) {c -(}}
		...
	{cmd:{c )-}}

{p 4 4 2}
or

	{cmd:if (all(x :>= 0)) {c -(}}
		...
	{cmd:{c )-}}

{p 4 4 2}
{cmd:allof()} and {cmd:anyof()} are used to look for special values:

	{cmd:if (allof(x, 0)) {c -(}}
		...
	{cmd:{c )-}}

{p 4 4 2}
or 

	{cmd:if (anyof(x, 0)) {c -(}}
		...
	{cmd:{c )-}}

{p 4 4 2}
Do not use {cmd:allof()} and {cmd:anyof()} to check for missing values --
e.g., {cmd:anyof(x, .)} -- because to really check, you would have to check
not only {cmd:.}, but {cmd:.a}, {cmd:.b}, ..., {cmd:.z}.  Instead use
{cmd:missing()}; see {bf:{help mf_missing:[M-5] missing()}}.


{title:Conformability}

    {cmd:all(}{it:L}{cmd:)}, {cmd:any(}{it:L}{cmd:)}:
		{it:L}:  {it:r x c}
	   {it:result}:  1 {it:x} 1


    {cmd:allof(}{it:P}{cmd:,} {it:s}{cmd:)}, {cmd:anyof(}{it:P}{cmd:,} {it:s}{cmd:)}:
		{it:P}:  {it:r x c}
		{it:s}:  1 {it:x} 1
	   {it:result}:  1 {it:x} 1


{title:Diagnostics}

{p 4 4 2}
{cmd:all(}{it:L}{cmd:)} and 
{cmd:any(}{it:L}{cmd:)} treat missing values in {it:L} as true.

{p 4 4 2}
{cmd:all(}{it:L}{cmd:)} and {cmd:any(}{it:L}{cmd:)} 
return 0 (false) if {it:L} is {it:r x} 0, 0 {it:x c}, or 0 {it:x} 0.

{p 4 4 2}
{cmd:allof(}{it:P}{cmd:,} {it:s}{cmd:)} and
{cmd:anyof(}{it:P}{cmd:,} {it:s}{cmd:)}
return 0 (false) if {it:P} is {it:r x} 0, 0 {it:x c}, or 0 {it:x} 0.


{title:Source code}

{p 4 4 2}
Functions are built-in.


{title:Also see}

{p 4 13 2}
Manual:  {hi:[M-5] all()}

{p 4 13 2}
Online:  help for 
{bf:{help m4_utility:[M-4] utility}}
{p_end}